Page tree
Skip to end of metadata
Go to start of metadata

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

This 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:
  $type: checkBoxField
  label: Show title
  buttonLabel: Select to display title

Checkbox field properties

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.

  • No labels