[MGNLUI-6222] DOC: currentItemProvider should not be used in multi fields Created: 21/Sep/20  Updated: 21/Oct/20  Resolved: 14/Oct/20

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

Type: Task Priority: Neutral
Reporter: Šimon Demočko 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-6316 DOC: Default to jcrChildNodeProvider ... Closed
relates to MGNLUI-6320 DOC: Using currentItemProvider in com... Closed
relates to MGNLUI-6332 DOC: Better explanation of itemProvid... Closed
relates to MGNLUI-6285 Consider notifying in Definition's ap... Open
Template:
Acceptance criteria:
Empty
Task DoR:
Empty
Date of First Response:
Epic Link: DOC: Restructure common field properties
Sprint: UI FW 13
Story Points: 2

 Description   

We want to avoid currentItemProvider usage with multis (may look for other candidates from code perspective in ConfiguredComplexPropertyDefinition), b/c it leads to issues like MGNLUI-5886.

The multi nodes could then be resolved by multiple fields that are using currentItemProvider, if they would resolve the same nodes - effectively overwriting each other's contents. Another problem that would result from using currentItemProvider is that if the multi field would be set to resolve non-strictly (strict property set to false, which is the default), the multi would be resolving irrelevant nodes (everything in the parent) which would result in errors.

One such place where this could be noted is in 
https://documentation.magnolia-cms.com/display/DOCS62/Field+definition#Fielddefinition-Commonfieldproperties. Also present here https://documentation.magnolia-cms.com/display/DOCS62/Item+providers though some clarification is already next to it, to it might be better to make it clearer.



 Comments   
Comment by Ashraf Khamis [ 14/Oct/20 ]

Within the scope of this ticket:

More changes will be made as part of a follow-up DOC ticket to document MGNLUI-6221 (see MGNLUI-6316). Reviewed by Šimon.

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