CheckBoxFieldDefinition 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
form: tabs: - name: tabtitle label: Title fields: - name: showTitle fieldType: checkbox label: Show title buttonLabel: Select to display title
Checkbox field properties
<field name> | Name of the field. |
| optional Label displayed to the right of the checkbox. The property is optional in the sense that if you don't 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.