Magnolia 5.7 reached extended end of life on May 31, 2022. Support for this branch is limited, see End-of-life policy. Please note that to cover the extra maintenance effort, this EEoL period is a paid extension in the life of the branch. Customers who opt for the extended maintenance will need a new license key to run future versions of Magnolia 5.7. If you have any questions or to subscribe to the extended maintenance, please get in touch with your local contact at Magnolia.
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 properties
Simple option field definition:
form: tabs: - name: tabTitle label: Title fields: - name: titleSelect fieldType: optionGroup 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 |
fieldType | optionGroup |
label | Title to use |
multiselect | true |
type | String |
Select, Option group and Twin-column fields follow this general configuration pattern, but also have additional properties.
Properties:
<field‑name> | required Name of field |
| required Parent node for the selectable options. |
| Name of the option. |
| required 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. |
| optional Option label displayed to the user. |
| optional Pre-selects the option. |
| optional, default is Read option labels from a different property. Set to the name of your custom label node. |
| optional Path to an existing option set as opposed to defining options in the current definition. |
| optional, default is When using a |
| optional, default is By default, option labels are sorted alphabetically. When set to |
| optional, default is Read option values from a different property. Set to the name of your custom value node. |
Properties specific to the option group field.
<field name> | Name of field. |
| optional, default is Alternatively use |
| optional, default is When set to |
or
| required Defines the field type via either a field alias name or a fully-qualified field definition class name. See Field definition: Field types. Use the Definitions app to check the correct form of the name. |
defaultValue | optional Pre-filled default value displayed in the field. The value can be overwritten by the user. Use alphanumeric characters.
|
description | optional Help text displayed when the user clicks the help icon. The value can be literal or retrieved from the message bundle with a key such as |
i18n | optional, default is 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 |
i18nBasename | optional, default is the message bundle defined in the dialog definition Message bundle such as |
label | optional Field label displayed to editors. The value can be literal such as If you don't provide the property then Magnolia falls back to a generated i18n key and displays they key in the UI. If you don't want a label at all then define the property and set its value to empty space such as |
name | optional, default is the name of the field's parent node Name of the node where the value is saved. The name |
placeholder | optional The placeholder text to be displayed in the empty field. The property replaces the deprecated placeholder text field.
The field is optional, but you should provide a translation or a hard-coded label, otherwise the empty field will display its auto-generated 18n key instead. |
readOnly | optional, default is Makes the field uneditable. Adding this property has the same effect as creating a Static field. |
required | optional, default is Makes the field required (mandatory). An asterisk is displayed next to the field label. See also Checking for null values. |
requiredErrorMessage | optional, default is 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 |
styleName | optional Adds one or more style names to this component. Multiple styles can be specified as a space-separated list of style names such as |
transformerClass | optional 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.
|
type | optional, most fields set a default value automatically PropertyType of the stored value such as |