[MGNLUI-5179] DOC: (Generic) Field definition reference page Created: 06/May/19  Updated: 17/May/19  Resolved: 17/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, Foundation 11
Story Points: 2

 Description   

Create a reference documentation for the "generic" field definition of the Magnolia 6 UI. 
Note that all specific field definitions (for specific fields) "inherit" from this "generic" field definition.

(The (old) Field definition of the Magnolia UI 5 can be used as inspiration.)

Page to update

https://documentation.magnolia-cms.com/display/DOCS61/Defining+fields

Possible content

  • Its fully qualified class name (fqcn) 
    => info.magnolia.ui.field.FieldDefinition
  • The list of the properties of the common field definition
  • a YAML snippet of a (simple) field definition 
     no more JCR based definition data (as we have it in Magnolia 5 UI docs.
  • A note that is a definition item of the (new) Magnolia 6 UI framework. 
    Maybe a link to the "old" ref. page.
  • Note that a field can be "referrenced" (in most of the cases) via $type property - if the specific field definition class is annotated with info.magnolia.ui.field.FieldType.

Properties list

 Note that info.magnolia.ui.field.FieldDefinition extends ...

  • info.magnolia.ui.field.EditorPropertyDefinition
  • info.magnolia.config.NamedDefinition

... hence, the properties list should contain the properties from the super-classes too.

For the complete list of the properties please check the java source files.

Sources

Java source files (on git)

 * info.magnolia.ui.field.FieldDefinition (ui project)
 * info.magnolia.ui.field.EditorPropertyDefinition (ui project)
 * info.magnolia.config.NamedDefinition (main project)

 



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

Page created at https://documentation.magnolia-cms.com/display/DOCS61/Defining+fields. Reviewed by Adam Siska.

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