Versions Compared

Key

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

Javadoc resource link
classNameinfo.magnolia.ui.field.CheckBoxFieldDefinition
renderTypeasynchronous
renders CheckBoxFieldDefinition renders a single checkbox. It is a simpler alternative to
Javadoc resource link
classNameinfo.magnolia.ui.field.CheckBoxGroupFieldDefinition
renderTypeasynchronous
.class:  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
languagejsyml
formcheckbox:
  tabs$type:
    - name: tabtitle
      label: Title
      fields:
        - name: showTitle
          fieldType: checkbox
           checkBoxField
  label: Show title
          buttonLabelbuttonLabel: Select to display title

...

Field properties

Field-specific properties

<field name>Name of the field.

buttonLabel

optionalrequired

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

If you do not property is optional in the sense that if you don't 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

Include Page
_Common simple field properties
_Common simple field properties
See also Common field properties.