Uploaded image for project: 'Magnolia UI'
  1. Magnolia UI
  2. MGNLUI-5179

DOC: (Generic) Field definition reference page

    XMLWordPrintable

Details

    • Task
    • Resolution: Done
    • Neutral
    • None
    • None
    • None

    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)

       

      Checklists

        Acceptance criteria

        Attachments

          Activity

            People

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

              Dates

                Created:
                Updated:
                Resolved:

                Checklists

                  Task DoR