Versions Compared

Old Version 21

changes.mady.by.user Ashraf Khamis

Saved on

compared with

New Version Current

changes.mady.by.user Ashraf Khamis

Saved on

Key

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

CheckBoxFieldDefinition renders a single checkbox. It is a simpler alternative to Javadoc resource linkclassNameinfo.magnolia.ui.field.CheckBoxGroupFieldDefinitionrenderTypeasynchronous.

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

optionalrequired

Label displayed next to the right of the checkbox.(warning) The value is i18n-able.

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

Common simple field properties

...