Select field

renders a dropdown list.

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

fieldType: select

Select field properties

Simple select field definition.

form:
  tabs:
    - name: tabLink
      label: Link
      fields:
        - name: listStyle
          fieldType: select
          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
fieldType	select
label	Link

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

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

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 .

pageLength

optional, default is 0

To enable paging and filtering, value must be an integer > 0 . The 0 setting disables paging and filtering.

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.

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.

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 such as products.product.description. 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.

Applicable in text and link 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.

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

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

Example: Filtered Select field

Example: Select field using startswith filtering mode and pagination set to 10 options per page.

form:
  tabs:
    - name: tabAddress
      fields:
        - name: country
          fieldType: select
          label: Country
          filteringMode: startswith
          pageLength: 10
          textInputAllowed: true
          options:
            - name: afghanistan
              value: afghanistan
            - name: argentina
              value: argentina           
            - name: australia
              value: australia          
            - name: austria
              value: austria             
            - name: belgium
              value: belgium         
            - name: brazil
              value: brazil           
            - name: bulgaria
              value: bulgaria            
            - name: canada
              value: canada            
            - name: chad
              value: chad            
            - name: chile
              value: chile           
            - name: china
              value: china             
            - name: cuba
              value: cuba            
            - name: czech-republic
              value: czech-republic            
            - name: denmark
              value: denmark

Node name	Value
form
tabs
tabAddress
fields
country
options
afghanistan
value	afghanistan
argentina
value	argentina
australia
value	australia
austria
value	austria
belgium
value	belgium
brazil
value	brazil
bulgaria
value	bulgaria
canada
value	canada
chad
value	chad
chile
value	chile
china
value	china
cuba
value	cuba
czech-republic
value	czech-republic
denmark
value	denmark
fieldType	select
filteringMode	startswith
pageLength	10
textInputAllowed	true

Here's the field in a dialog.

Page tree

Select field

Select field properties

Example: Filtered Select field