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

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

See Referencing fields for further information.

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.

value

required

Value saved to the repository when selected.

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. 

label

optional

Option label displayed to the user.

selected

optional

Pre-selects the option.

labelProperty

optional, default is label

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

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.

sortOptions

optional, default is true

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

valueProperty

optional, default is value

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.

layout

optional, default is vertical

Alternatively use horizontal .

multiselect

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:

fieldType

or

class

required

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.

defaultValue

optional

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

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

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. Use alphanumeric characters in literal values. Not applicable to the static field.

i18n

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.

i18nBasename

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.

label

optional

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 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 label: " " in YAML.

name

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

optional

The placeholder text to be displayed in the empty field. The property replaces the deprecated placeholder text field.

(warning) Applicable in the textlink and comboBox fields.

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 false

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

required

optional, default is false

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

requiredErrorMessage

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.

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 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.

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.

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

type

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.