Option group field - 5 UI


This option group field definition has been deprecated since Magnolia 6.0. It is part of the Magnolia 5 UI framework.

For the updated implementation, see Option group field for Magnolia 6 UI instead.

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

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

fieldType: optionGroup

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 dialog

Option group properties

Simple option field definition:

    - name: tabTitle
      label: Title
        - name: titleSelect
          fieldType: optionGroup
          multiselect: true
          type: String
          label: Title to use
            - name: pageTitle
              label: Page title
              selected: true
            - name: navigationTitle
              label: Navigation title
              value: navigationTitle
            - name: none
              label: None
              value: none

Referencing fields shortcut info - 5 UI

See Referencing fields for further information.

Common select field properties - 5 UI

The select, option group and twin-column fields share this general configuration pattern, but they also have their own additional properties.

<field name>


Name of the field.



Parent node for the selectable options. If not set, the field generates options from the repository path.

<option name>

Name of the option.



Value saved to the repository when selected.


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.



Option label displayed to the user.



Displays an image next to the option. Value is a path to the image.


optional, default is false

Pre-selects the option.


optional, default is `label`

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



Path to existing options as opposed to defining options in the current definition. Only valid with a field defined in XML.

Alternatively, option definitions can be placed in a YAML file referenced via include.


optional, default is `RepositoryConstants.CONFIG`

When using a path to existing options, workspace to look in.


optional, default is true

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


optional, default is `info.magnolia.ui.form.field.factory.SelectFieldFactory.DefaultOptionComparator`

When sortOptions set to true, sorts the available options.


optional, default is value

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

Property Description

<field name>

Name of field.


optional, default is `vertical`

Alternatively use horizontal.


optional, default is false

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

Common field properties - 5 UI

Property Description

fieldType`or `class


Defines the field type via either a field alias name or a fully-qualified field definition class name. See Field definition: Field types.

To check the correct form of the name, use the Definitions app.



Pre-filled default value displayed in the field. The value can be overwritten by the user. Use alphanumeric characters.

Applied only when creating a new item, not for already existing items.



Help text displayed when the user clicks the help icon. The value can be literal or retrieved from the message bundle with a key. Use alphanumeric characters in literal values. Not applicable to the static field.


optional, default is false

Enables i18n authoring support which allows editors to write foreign-language or regionally targeted content. A two-letter language identifier (en, de, fr etc.) is displayed on controls where i18n is set to true.


optional, default is the message bundle defined in the dialog definition_

Message bundle such as com.example.messages for localized field labels. You can set this property in the parent dialog, form or tab definition. Child fields will inherit the bundle.



Field label displayed to editors. The value can be literal such as Product name or retrieved from the message bundle with a key such as products.product.label. Use alphanumeric characters in literal values.

If you do not provide the property, Magnolia will fall back to a generated i18n key and display the key in the UI.

If you do not want a label at all, define the property and set its value to a blank space such as label: " " in YAML.


optional, default is the name of the field’s parent node_

Name of the node where the value is saved. The name jcrName is reserved. Use alphanumeric characters.



Placeholder text to be displayed when the field is empty. The value is i18n-able.

Applicable to text, link and combobox fields.


optional, default is false

Makes the field uneditable. Adding this property has the same effect as creating a static field.


optional, default is false

Makes the field required (mandatory). An asterisk is displayed next to the field label. See also Checking for null values.


optional, default is This field is required

Error message displayed when required is true and the user saves an empty field. The value can be literal or retrieved from the message bundle with a key such as validation.message.required.



Adds one or more style names to this component. Multiple styles can be specified as a space-separated list of style names such as checkbox disabled. The style name will be rendered as an HTML class name, which can be used in a CSS definition. The class name is added to the field by calling the Vaadin method addStyleName.



Property transformer classes define how field values are stored in the repository. Each field has a default transformer class. You don’t need to define a class unless you want to override the default. The value is a fully-qualified class name.

Complex field definitions may define a different default transformer in their constructor. See Transforming field values for more.


optional, most fields set a default value automatically

JCR property type of the stored value such as String, Boolean, Date or any other supported and defined data type.


DX Core



This widget lets you know where you are on the docs site.

You are currently perusing through the DX Core docs.

Main doc sections

DX Core Headless PaaS Legacy Cloud Incubator modules
6.3 beta

Magnolia 6.3 beta

Magnolia 6.3 is in beta. We are updating docs based on development and feedback. Consider the 6.3 docs currently in a state of progress and not final.

We are working on some 6.3-beta known issues during this phase.