[MAGNOLIA-7486] DOC: Field references with $type and 'type resolver' Created: 21/Mar/19  Updated: 28/May/19  Resolved: 28/May/19

Status: Closed
Project: Magnolia
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-data-binding
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
relation
is related to MAGNOLIA-7469 Annotation processing type resolver i... Closed
is related to MGNLUI-5027 Use type aliases in framework Closed
Template:
Acceptance criteria:
Empty
Task DoR:
Empty
Date of First Response:
Epic Link: DOC: Documentation for Magnolia 6.1
Sprint: Foundation 11
Story Points: 2

 Description   

Context

The new UI frameworks has ditched (or is not using anymore) the field registry as known in ui-5.7.x.

Now there is a new thingy named type resolver.
Related dev tickets:

The type resolver scans classes which are annotated with info.magnolia.ui.field.FieldType.

In a form definition, fields can be referenced by using the $field property, where the value is a short and easy to remember string. (That string is defined in the annotation which is applied to field definition class.

Example:

@FieldType("checkBoxField")
public class CheckBoxFieldDefinition extends ConfiguredFieldDefinition<Boolean> {
...
}

Tasks

Minimum

  • Provide a list of all fields which belong to a Magnolia module (incl. all modules which are bundled in DX Core). 
    The list should be a look-up table with:
    • "short name" 
    • fully qualified class name
    • quick description of the fields
    • Link to the existing field reference page - if it exists
  • Show how to use it in a form definition (in a YAML file)


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

Info added to the $type property on the following pages:

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

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

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

Content reviewed by Robert

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