[MGNLUI-5180] DOC: Create "List of field types" Created: 06/May/19  Updated: 13/May/19  Resolved: 13/May/19

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

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

Template:
Acceptance criteria:
Empty
Task DoR:
Empty
Date of First Response:
Epic Link: DOC: Documentation for Magnolia 6.1
Sprint: Foundation 10
Story Points: 2

 Description   

Create a list of all the fields which can be used in the (new) Magnolia 6 UI form framework;
on a page of the hidden sub-tree https://documentation.magnolia-cms.com/display/DOCS61/_Inclusions+library.

Page to update:

https://documentation.magnolia-cms.com/display/DOCS61/_field+definition+classes+for+Magnolia+6+UI

The list can / could be used on the (new) pages for Form definition, maybe on _(Common) field definition (and others maybe).

Content

Similar to the "old" version _field definition classes - create a table with 2 rows:

  • Fully qualified class name
  • The value to use with the $type property. *

*) To figure out the value of the $type property, you must check the source code and check the value of the info.magnolia.ui.field.FieldType annotation.

List all the classes. whether the have info.magnolia.ui.field.FieldType annotation or not.

How to find the field definition classes?

This can be challenging, since these classes could in theory be distributed among a bunch of different modules.

Start with the "ui-project" (and all its sub modules), search for classes which directly or indirectly extend or implement info.magnolia.ui.field.FieldDefinition.

For other modules: Ask developers colleagues, which other modules are utilizing the M. 6 UI frameworks.



 Comments   
Comment by Ashraf Khamis [ 13/May/19 ]

cmeier, page created at https://documentation.magnolia-cms.com/display/DOCS61/_field+definition+classes+for+Magnolia+6+UI and used for the new (M6 UI) Defining forms page (https://documentation.magnolia-cms.com/display/DOCS61/Defining+forms).

Comment by Christoph Meier [ 13/May/19 ]

Reviewed. Looks good. Feel free to close it.

I probably will check some other modules (such as dam), whether we have some more fields. If I find some, I will add them.

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