Magnolia 5.5 reached end of life on November 15, 2019. This branch is no longer supported, see End-of-life policy.

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

OptionGroupFieldDefinition renders radio buttons or checkboxes depending on how the multiselect property is set.

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

Example: In the screenshot below:

  • multiselect=true: Options are displayed as checkboxes. More than one can be selected.
  • multiselect=false: Options are displayed as radio buttons. Only one can be selected.

Option group properties

Simple option field definition:

form:
  tabs:
    - name: tabTitle
      label: Title
      fields:
        - name: titleSelect
          class: info.magnolia.ui.form.field.definition.OptionGroupFieldDefinition
          multiselect: true
          type: String
          label: Title to use
          options:
            - name: pageTitle
              label: Page title
              selected: true
            - name: navigationTitle
              label: Navigation title
              value: navigationTitle
            - name: none
              label: None
              value: none

Node name

Value

 form


 tabs


 tabText


 fields


 titleSelect


 options


 pageTitle


 label

Page title

 selected

true

 value

pageTitle

 navigationTitle


 label

Navigation title

 value

navigationTitle

 none


 label

None

 value

none

 class

info.magnolia.ui.form.field.definition.OptionGroupFieldDefinition

 label

Title to use

 multiselect

true

 type

String

You can use all common field properties and the following:


Select, Option group and Twin-column fields follow this general configuration pattern, but also have additional properties.

Properties:

<field‑name>

required

Name of field

options

required

Parent node for the selectable options.

<option‑name>

Name of the option.

name

optional, default is the parent node name

Name of the node where the selected value is stored. If not set, the name of the parent node is used. 

value

required

Value saved to the repository when selected.

label

optional

Option label displayed to the user.

selected

optional

Pre-selects the option.

path

optional

Path to an existing option set as opposed to defining options in the current definition.

repository

optional, default is config

When using a path to an existing option set, workspace to look in.

valueProperty

optional, default is value

Read option values from a different property. Set to the name of your custom value node.

labelProperty

optional, default is label

Read option labels from a different property. Set to the name of your custom label node.

sortOptions

optional, default is true

By default, option labels are sorted alphabetically. When set to false sorts the options per JCR node order.

Properties specific to the option group field.

<field name>Name of field.

multiselect

optional, default is false

When set to true, options are rendered as checkboxes. When set to false, options are rendered as radio buttons.

layout

optional, default is vertical

Alternatively use horizontal.

  • No labels