Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

CheckBoxFieldDefinition renders a single checkbox. It is a simpler alternative to CheckBoxGroupFieldDefinition.

Info

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.

Table of Contents

Example definition

Code Block
languageyml
checkbox:
  $type: checkBoxField
  label: Show title
  buttonLabel: Select to display title

Field properties

Field-specific properties

buttonLabel

required

Label displayed next to the checkbox. The value is i18n-able.

If you do not want to have any label, set the property to an empty string in YAML or in a message bundle.

Common simple field properties

Include Page
_Common simple field properties
_Common simple field properties