[MGNLUI-6332] DOC: Better explanation of itemProvider on multi field page Created: 19/Oct/20  Updated: 23/Nov/20  Resolved: 23/Nov/20

Status: Closed
Project: Magnolia UI
Component/s: None
Affects Version/s: 6.2.4
Fix Version/s: None

Type: Task Priority: Neutral
Reporter: Chris Jennings Assignee: Ashraf Khamis
Resolution: Done Votes: 0
Labels: fields, new-UI-framework, new-form
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Relates
relates to MGNLUI-6222 DOC: currentItemProvider should not b... Closed
relates to MGNLUI-6316 DOC: Default to jcrChildNodeProvider ... Closed
relates to MGNLUI-6320 DOC: Using currentItemProvider in com... Closed
Template:
Acceptance criteria:
Empty
Task DoR:
Empty
Date of First Response:
Epic Link: DOC: Restructure common field properties
Sprint: UI FW 15
Story Points: 2

 Description   

Hi.
The current multi field page is confusing and the lack of detail about item providers can cause errors in version prior to 6.2.4

The three different fields treat item providers differently across versions and it is difficult to explain to users. I would like to propose that an entry is added to the properties table for itemProvider, referencing common properties.

My suggestion

itemProvider
Optional for some field since 6.2.4, default is
info.magnolia.ui.editor.JcrPropertyProvider for JcrMultiValueFieldDefinition
info.magnolia.ui.editor.JcrChildNodeProviderDefinition for jcrMultiField
None for jsonMultiField

Prior to 6.2.4, jcrMultiField has no default.
See also: Common properties (linked)

I appreciate the desire to document only the latest patch release. ie
https://magnolia-cms.slack.com/archives/CDF8GN6ER/p1600265852074500

However, the example jcrMultiField that exists since MGNLUI-6316 has no itemProvider and in Magnolia 6.2.3 triggers a null pointer exception with very little explanation.



 Comments   
Comment by Ashraf Khamis [ 23/Nov/20 ]

Reviewed by Roman.

Generated at Mon Feb 12 09:35:25 CET 2024 using Jira 9.4.2#940002-sha1:46d1a51de284217efdcb32434eab47a99af2938b.