Magnolia 5.4 reached end of life on November 15, 2018. This branch is no longer supported, see End-of-life policy.
MultiValueFieldDefinition renders multiple fields that allow the user to either enter multiple values such as items in a shopping list or select multiple items such as categories for tagging content. The multivalue field saves the entered values as a LinkedList<T> collection by default. You can save them in a different way by using a multivalue property transformer.
class: info.magnolia.ui.form.field.definition.MultiValueFieldDefinition
The multivalue field is commonly used to select targets inside Magnolia, for example categories for a page.
Simple multivalue field configuration.
form:
tabs:
- name: tabMain
label: Categories
fields:
- name: selectCategories
class: info.magnolia.ui.form.field.definition.MultiValueFieldDefinition
label: Select category
field:
name: linkField
class: info.magnolia.ui.form.field.definition.LinkFieldDefinition
targetWorkspace: category
appName: categories
identifierToPathConverter:
class: info.magnolia.ui.form.field.converter.BaseIdentifierToPathConverter
Node name | Value |
|---|---|
info.magnolia.ui.form.field.converter.BaseIdentifierToPathConverter | |
info.magnolia.ui.form.field.definition.LinkFieldDefinition | |
category | |
categories | |
info.magnolia.ui.form.field.definition.MultiValueFieldDefinition | |
Select category | |
You can use only the name, type, label, description and styleName common field properties and the following properties in a multivalue field definition:
Properties
<field name> | required Name of field |
| required Parent node for the nested child field. Must be named "field". |
| required Child field definition class. |
| required/optional* Any other nodes and properties supported by the child field definition class. *Any required properties must be added. |
| optional, default is Button label for adding more fields. |
| optional, default is Button label for selecting an item. |
| optional, default is Button label for selecting a different item. |
| optional, default is Property transformer class. Defines how the values are stored in the repository. See also Which transformer should I use? |
Best practice
When nesting multivalue fields, use the delegating transformer classes, DelegatingCompositeFieldTransformer or DelegatingMultiValueFieldTransformer, rather than the other available transformer classes.
Here is an example of a multivalue field that contains a single text field. The parent shopping list is the multivalue field, list items are text fields.
In configuration, define the parent multivalue field first, then add a field node, and define the child field's properties under it.
form:
tabs:
- name: tabMain
label: Main
fields:
- name: shoppingList
class: info.magnolia.ui.form.field.definition.MultiValueFieldDefinition
label: Shopping list
field:
class: info.magnolia.ui.form.field.definition.TextFieldDefinition
label: Title
| Node name | Value |
|---|---|
| info.magnolia.ui.form.field.definition.TextFieldDefinition | |
| Title | |
| info.magnolia.ui.form.field.definition.MultiValueFieldDefinition | |
| Shopping list |
Here is an example event list. The parent list is a multivalue field. Each event is a composite field that consists of a text field and a date field.
Note how the NoOpCompositeTransformer is used to prevent the composite field from saving the field values. The NoOpCompositeTransformer hands the responsibility of saving values to the multivalue parent. The default transformer for the multivalue field is the MultiValueTransformer. However, here we cannot use it because it would store the child values in one multivalue property that looks like a comma separated list. That single property is bound to a single type. It cannot handle two different types of values: strings and dates. The solution is to use the MultiValueSubChildrenNodePropertiesTransformer which stores each value in a separate property, allowing them to be of different types.
form:
tabs:
- name: tabText
label: Multivalue composite
fields:
- name: events
class: info.magnolia.ui.form.field.definition.MultiValueFieldDefinition
label: Events
transformerClass: info.magnolia.ui.form.field.transformer.multi.MultiValueSubChildrenNodePropertiesTransformer
field:
name: compositeField
class: info.magnolia.ui.form.field.definition.CompositeFieldDefinition
transformerClass: info.magnolia.ui.form.field.transformer.composite.NoOpCompositeTransformer
fields:
- name: title
class: info.magnolia.ui.form.field.definition.TextFieldDefinition
label: Title
- name: date
class: info.magnolia.ui.form.field.definition.DateFieldDefinition
label: Date
| Node name | Value |
|---|---|
| info.magnolia.ui.form.field.definition.TextFieldDefinition | |
| Title | |
| info.magnolia.ui.form.field.definition.DateFieldDefinition | |
| Date | |
| info.magnolia.ui.form.field.definition.CompositeFieldDefinition | |
| info.magnolia.ui.form.field.transformer.composite.NoOpCompositeTransformer | |
| info.magnolia.ui.form.field.definition.MultiValueFieldDefinition | |
| Events | |
| info.magnolia.ui.form.field.transformer.multi.MultiValueSubChildrenNodePropertiesTransformer |