[MGNLUI-7215] DEV-DOC: Create a custom ItemProvider Created: 07/Jun/22  Updated: 28/Jun/22  Resolved: 28/Jun/22

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

Type: Bug Priority: Medium
Reporter: Alex Mansell Assignee: Dominik Maslanka
Resolution: Won't Do Votes: 0
Labels: None
Σ Remaining Estimate: Not Specified Remaining Estimate: Not Specified
Σ Time Spent: Not Specified Time Spent: Not Specified
Σ Original Estimate: Not Specified Original Estimate: Not Specified

Sub-Tasks:
Key
Summary
Type
Status
Assignee
MGNLUI-7258 Developer rw Sub-task Closed  
MGNLUI-7259 Grammar rw Sub-task Closed  
MGNLUI-7260 Docu PR Sub-task Closed Roman Kovařík  
MGNLUI-7278 Ask if customer has checked the exist... Sub-task Closed Dominik Maslanka  
Template:
Acceptance criteria:
Empty
Task DoD:
[ ]* Doc/release notes changes? Comment present?
[ ]* Downstream builds green?
[ ]* Solution information and context easily available?
[ ]* Tests
[ ]* FixVersion filled and not yet released
[ ]  Architecture Decision Record (ADR)
Bug DoR:
[ ]* Steps to reproduce, expected, and actual results filled
[ ]* Affected version filled
Documentation update required:
Yes
Date of First Response:
Epic Link: Maintenance of vaadin8 framework
Sprint: Nucleus 13
Story Points: 3
T-Shirt Size: Large
Team: Nucleus

 Description   

We received another issue with clarity on docs - please let me know what details we would need here to reply to customer needs. 

Here's another topic that I think deserves better developer
documentation: form fields, and itemProviders in particular.

I'd like to write a custom itemProvider and find the involved
concepts/java API difficult to understand.

The situation is similar to UI context. I have no problems to adapt
existing code but don't understand how the involved classes work, e.g.
ItemProviderStrategy, ItemProviderDefinition, etc.

The comments in the corresponding classes are also of little help (and
sometimes even misleading). See the comment for ItemProviderStrategy for
a good example: super cryptic and in part contradictory.
https://git.magnolia-cms.com/projects/PLATFORM/repos/ui.pub/browse/magnolia-ui-framework/src/main/java/info/magnolia/ui/editor/ItemProviderStrategy.java
Could you add docs that make clear how the Magnolia java side of forms
works, like what you did for the UI Context API?



 Comments   
Comment by Mercedes Iruela [ 21/Jun/22 ]

https://docs.magnolia-cms.com/product-docs/6.2/Developing/Templating/Dialog-definition/Field-definition/Item-providers.html

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