Combobox field
ComboBoxFieldDefinition
renders a combobox where only one item can be selected (comboBoxField
).
The component has a text field where items can be filtered based on user input.
ComboBoxFieldDefinition
extends the AbstractSelectFieldDefinition
class.
The For JSON data sources, use the JsonComboBoxFieldDefinition. |
There is also JsonComboBoxFieldDefinition
to be used with the JSON data source (jsonComboBoxField
).
Example definitions
Combobox field
comboSelect:
$type: comboBoxField
label: Prefix
datasource:
$type: optionListDatasource
options:
- name: mr
label: Mr.
value: mr
- name: mrs
label: Mrs.
value: mrs
- name: miss
label: Miss
value: miss
You can preview this example using the |
JSON Combobox field
comboBoxFieldwithJSON:
label: Definition example
$type: jsonComboBoxField
textInputAllowed: true
filteringMode: CONTAINS
datasource:
name: rest
$type: jsonDatasource
restClient: books
restCall: wordSearch
jsonPathExpressions:
itemId: '$.definition'
items: '$..meanings[*].definitions[*]'
describeBy: '$.definition'
You can preview this example using the |
Field properties
Common combobox field properties
Property | Description |
---|---|
|
optional, default is Defines whether the user can select nothing in the field. When |
|
optional, default is empty string When |
|
optional, default is Sets the number of items in the field pop-up. The value must be between |
|
optional Placeholder text to be displayed when the field is empty. The value is i18n-able. |
|
optional Sets the width of the field pop-up relative to the field itself. If no value is specified, the pop-up’s width will automatically expand to fit the content of all displayed items. |
|
optional, default is Defines whether the selected item is always scrolled into view when the comboBox pop-up has multiple pages. Possible values are It’s useful for users who want automatic scrolling to the selected item, especially when the selected item is not shown in the pop-up’s first pages and the pop-up has several pages between which the user can scroll up and down. But be aware: setting |
|
optional, default is When When |
Common select field properties
Property | Description | ||
---|---|---|---|
|
required Connects the field to a data source. Options are populated via the configured data source. Use the fully qualified class name or the |
||
|
optional, default is Defines how options are filtered. Other possible values are
|
Common simple field properties
Property | Description | ||||||
---|---|---|---|---|---|---|---|
|
required Name of the field definition item. Derived from the configured node name. Use alphanumeric characters without spaces. |
||||||
|
required (unless Type of the field definition item. The value must be a fully qualified
class name and a subtype of |
||||||
|
You can use this as a shortcut for Example class annotation
See Field types for possible values. |
||||||
|
optional Property type of the field.
|
||||||
|
optional Converts values between the presentation (UI) and model (stored data). The property must extend
|
||||||
|
optional, default is translated Message shown when there is an error in the conversion process. The value can be literal or a key of a message bundle. |
||||||
|
optional Pre-filled default value displayed in the field. The value can be overwritten by the user. Use alphanumeric characters.
|
||||||
|
optional Help text displayed when the user clicks the help icon. The value can be literal or a key of a message bundle. |
||||||
|
optional Defines the factory class that initializes and builds the Vaadin form field. The default factory class depends on the particular field. The value must be a fully qualified class name and a subtype of
|
||||||
|
optional Defines the binder class that applies configuration parameters from the field. |
||||||
|
optional, default is Enables i18n authoring support, which allows editors to write foreign-language or regionally targeted content. For more details, see i18n in New UI Forms and Vaadin forms. |
||||||
|
optional Field label displayed to editors. The value can be literal or a key of a message bundle. If you do not provide the property, Magnolia will fall back to a generated i18n key. If you do not want to have any label, set the property to an empty
string such as |
||||||
|
optional, default is Makes the field uneditable. |
||||||
|
optional, default is Makes the field required. When
|
||||||
|
optional, default is translated Error message shown when |
||||||
|
optional Additional style information for an editor property definition item applied to the element when the form is rendered. The value can be a CSS class or a list of CSS classes separated by white spaces. 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
|
||||||
|
optional List of field validator definition items. Any value must be a subtype of
See Field validators for more information. |
i18n in New UI Forms and Vaadin forms
The rendering and behavior of internationalization (i18n) differ between the fields of the New UI Forms and the older Vaadin forms.
Fields with i18n: true
New UI Forms | Vaadin |
---|---|
No language identifier is displayed next to the field’s name. The field value you edit there and save is stored only for the selected language variant. |
A two-letter language identifier (for example, The field value you edit there and save is stored only for the selected language variant. |
Fields with i18n: false
(or not set, as false
is the default)
New UI Forms | Vaadin |
---|---|
Editing is only possible in the default language. The field is disabled in non-default language views. A globe icon is displayed next to the field. Hovering over the globe icon shows a tooltip with the following messages:
|
No language identifier is displayed next to the field’s name. The field is editable. The value you enter there and save is applied to all language variants. |
Default language form views (English)

Non-default language form views (German)
