Uploaded image for project: 'Magnolia'
  1. Magnolia
  2. MAGNOLIA-7486

DOC: Field references with $type and 'type resolver'

XMLWordPrintable

    • Foundation 11
    • 2

      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)

        Acceptance criteria

              akhamis Ashraf Khamis
              cmeier Christoph Meier
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Created:
                Updated:
                Resolved:

                  Task DoR