Versions Compared

Old Version 5

changes.mady.by.user Ashraf Khamis

Saved on

compared with

New Version 6

changes.mady.by.user Ashraf Khamis

Saved on

Key

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

Javadoc resource link
classNameinfo.magnolia.ui.field.CheckBoxFieldDefinition
renderTypeasynchronous
renders a single checkbox. It is a simpler alternative to
Javadoc resource link
classNameinfo.magnolia.ui.field.CheckBoxGroupFieldDefinition
renderTypeasynchronous
.

Info

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 checkbox field definition

Code Block
languageyml
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.

buttonLabel

optional

Label displayed to the right of the checkbox.

(warning) 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.