This documentation is still in progress. We are working hard to update all our screenshots to the new Magnolia 6 style. Please bear with us.

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

CheckboxFieldDefinition renders a single checkbox. It is a simpler alternative to Option group.

class: info.magnolia.ui.form.field.definition.CheckboxFieldDefinition

fieldType: checkbox

Checkbox field properties

Simple checkbox field definition:

form:
  tabs:
    - name: tabtitle
      label: Title
      fields:
        - name: showTitle
          fieldType: checkbox
          label: Show title
          buttonLabel: Select to display title

Node name

Value

 form


 tabs


 tabTtile


 fields


 showTitle


 buttonLabel

Select to display title

 fieldType

checkbox

 label

Show title

See Referencing fields for further information.

You can use common field properties and the following properties in a checkbox field definition:

Properties:

<field name>Name of field.

buttonLabel

optional

Label displayed to the right of the checkbox.