Magnolia 5.6 reached end of life on June 25, 2020. This branch is no longer supported, see End-of-life policy.
CheckboxFieldDefinition renders a single checkbox. It is a simpler alternative to Option group.
class: info.magnolia.ui.form.field.definition.CheckboxFieldDefinition
Simple checkbox field definition:
form: tabs: - name: tabtitle label: Title fields: - name: showTitle class: info.magnolia.ui.form.field.definition.CheckboxFieldDefinition label: Show title buttonLabel: Select to display title
Node name | Value |
---|---|
form | |
tabs | |
tabTtile | |
fields | |
showTitle | |
buttonLabel | Select to display title |
class | info.magnolia.ui.form.field.definition.CheckboxFieldDefinition |
label | Show title |
You can use common field properties and the following properties in a checkbox field definition:
Properties:
<field name> | Name of 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. |