...
- An item provider only needs to know how to access the data. In contrast, the transformers in the 5 UI framework were responsible for both types of data operations – reading and writing. In Magnolia 6 UI, data updates should be piped into back-end items via simple fields by means of Vaadin 8 data binding (Binder objects).
- Unlike transformers, item providers do not have to deal with the deprecated Vaadin 7 Item API and do not require manual verifications that child properties are populated within an item.
- Item providers have a clearer concept of chaining. They get a reference of an item from a previous level in the hierarchy, making the whole complex data binding process recursive.
- The number of provider types is much lower in Magnolia 6 UI, compared to a relatively high number of field transformers in the 5 UI.
- There's also provider implementations that can handle JSON structures, task and notifications items, assets or specific product content items.
Where
...
they can be used
Item providers can be used in:
...
| $type | class and description |
|---|
currentItemProvider | info.magnolia.ui.editor.CurrentItemProviderDefinition
Returns the parent node. Suitable for sub-forms only since it relies on a parent. | Warning |
|---|
Do not use currentItemProvider with multi fields. The same nodes could be resolved by multiple fields that use currentItemProvider, which means their content would be overwritten. Additionally, if a multi field is not configured to resolve nodes strictly (the strict property is set to false by default), it will resolve irrelevant nodes from the parent and likely result in errors. |
| Note |
|---|
If you use currentItemProvider with composite or switchable fields, make sure that none of the inner field names clash with: - Other inner field names at the level where
currentItemProvider is used - Other field names one level up where the composite or switchable field is defined
That is, every field at every level must have a unique name. Otherwise, nodes sharing the same name could be resolved by multiple fields that use currentItemProvider, which means their content would be overwritten. | Code Block |
|---|
| language | yml |
|---|
| title | Example name conflict |
|---|
| collapse | true |
|---|
| form:
properties:
first_compositeField:
$type: compositeField
itemProvider:
$type: currentItemProvider
properties:
inner_simple: # duplicate name
$type: textField # first text
inner_simple2:
$type: textField # second text
second_compositeField:
$type: compositeField
itemProvider:
$type: currentItemProvider
properties:
inner_simple3:
$type: textField # third text
inner_simple: # duplicate name
$type: textField # fourth text
# Problem with using currentItemProvider
edited_node:
inner_simple: fourth text # first text is overwritten by second inner_simple
inner_simple2: second text
inner_simple3: third text
# Using jcrChildNodeProvider with both composite fields would fix the problem
edited_node:
first_compositeField:
inner_simple: first text
inner_simple2: second text
second_compositeField:
inner_simple3: third text
inner_simple: fourth text # no name conflict |
|
|
For JCR data source
| $type | class and description |
|---|
jcrChildNodeProvider | info.magnolia.ui.editor.JcrChildNodeProviderDefinition
Resolves a JCR child node from the parent. Suitable for sub-forms only since it relies on a parent. | Info |
|---|
jcrChildNodeProvider is used by default in | Javadoc resource link |
|---|
| className | info.magnolia.ui.field.JcrMultiFieldDefinition |
|---|
| renderType | asynchronous |
|---|
|
.
|
|
jcrGetIndexedChildNode | info.magnolia.ui.editor.JcrIndexedChildNodeProvider
Resolves an indexed JCR child node from the parent. Suitable for sub-forms only since it relies on a parent. |
jcrGetProperty
| info.magnolia.ui.editor.JcrPropertyProvider
Proposes a JCR node property as an item datasource. Typically used in complex fields with sub-editors where a single field entry needs to be exposed as an editor. | Info |
|---|
jcrGetProperty is used by default in | Javadoc resource link |
|---|
| className | info.magnolia.ui.field.JcrMultiValueFieldDefinition |
|---|
| renderType | asynchronous |
|---|
|
.
|
|
jcrNodeFromLocationProvider | info.magnolia.ui.editor.JcrNodeFromLocationResolutionDefinition
Resolves JCR node content from the current location. |
...