Select field

SelectFieldDefinition renders a dropdown list.

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

Select field properties

Simple select field definition.

form:
  tabs:
    - name: tabLink
      label: Link
      fields:
        - name: listStyle
          class: info.magnolia.ui.form.field.definition.SelectFieldDefinition
          label: List style
          options:
            - name: bullet
              value: bullet
              selected: true
              label: Bullet
            - name: ordered
              value: ordered
              label: Ordered
            - name: inline
              value: inline
              label: Inline

Node name	Value
form
tabs
tabLink
fields
listStyle
options
bullet
label	Bullet
selected	true
value	bullet
ordered
label	Ordered
value	ordered
inline
label	Inline
value	inline
class	info.magnolia.ui.form.field.definition.SelectFieldDefinition
label	Link

You can use all common field properties and the following.

`<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.
`textInputAllowed`	optional, default is `false` When `true`, the user can type into the select field to filter the available options. The `filteringMode` property defines how the options are filtered: contains or starts with. When `false`, the field behaves like a standard select field where the user can not enter text. Clicking the field opens the dropdown with options. This property does not make it possible to enter new values into the field. The user can only choose from existing options.
`filteringMode`	optional, default is `off` Vaadin `FilteringMode`. Default is `off` . Available values are: `contains` and `startswith` . To enable filtering, you must also: Set the `pageLength` property to a value greater than `0` . Set the `textInputAllowed` property to `true` .
`sortOptions`	optional, default is `true` By default, option labels are sorted alphabetically. When set to `false` sorts the options per JCR node order.
`pageLength`	optional, default is `0` To enable paging and filtering, value must be an integer > `0`. `0` disables paging and filtering.

All fields that allow users to make a selection (select, option group, twin-column, checkbox) follow this pattern but some have additional properties.

Page tree

Select field

Select field properties