You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 10 Next »

Checkbox field definition renders a single checkbox. It is a simpler alternative to CheckBoxGroupFieldDefinition.

Checkbox field definition is part of the Magnolia 6 UI framework. The fully qualified class name is info.magnolia.ui.field.CheckBoxFieldDefinition.

If you work with the Magnolia 5 UI framework, see Checkbox field for Magnolia 5 UI instead.

Example checkbox field definition

checkbox:
  name: showTitle
  $type: checkBoxField
  label: Show title
  buttonLabel: Select to display title

Checkbox field properties

<field name>Name of the field.

class

required (unless $type is used)

Fully qualified name of the checkbox field definition class.

If the definition class is annotated with info.magnolia.ui.field.FieldType, you can use the $type property instead.

$type

You can use this as a shortcut for class if the definition class is annotated with info.magnolia.ui.field.FieldType. The proper value is defined by the annotation.

Example class annotation 
@FieldType("checkBoxField")
public class CheckBoxFieldDefinition extends ConfiguredFieldDefinition<Boolean> {
...
}

To use the $type property in YAML, see Checkbox field - 6 UI.

buttonLabel

optional

Label displayed to the right of the checkbox.

(warning) The property is optional in the sense that if you do not want to have the label rendered at all, you have to set an empty string as its value (either in the YAML configuration or in a message bundle).

See also Common field properties.

#trackbackRdf ($trackbackUtils.getContentIdentifier($page) $page.title $trackbackUtils.getPingUrl($page))
  • No labels