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

DOC: Separate tables for common complex and common simple field properties

    XMLWordPrintable

Details

    Description

      The following common properties cannot be used in complex fields:

      • type
      • required
      • requiredErrorMessage
      • conversionErrorMessage
      • readOnly
      • defaultValue
      • validators
      • converterClass
      • factoryClass
      • fieldBinderClass

      We can add "not used in compositemulti and switchable fields" to each of the above properties or add another column to the common field properties table to list all applicable/non-applicable fields for each property. A better approach would be to create a separate common complex field properties table to list all common composite, multi and switchable field properties.

       For better visibility, consider adding common field properties as an includable to every field page below the field-specific properties.

      Common simple field properties

      https://git.magnolia-cms.com/projects/PLATFORM/repos/ui/browse/magnolia-ui-framework/src/main/java/info/magnolia/ui/field/ConfiguredFieldDefinition.java

      • name
      • class
      • $type
      • label
      • description
      • i18n
      • styleName
      • type
      • required
      • requiredErrorMessage
      • conversionErrorMessage
      • readOnly
      • defaultValue
      • validators
      • converterClass
      • factoryClass
      • fieldBinderClass

      Since placeholder can only be used in combobox and text fields, it should not be listed as a common field property. Instead, add placeholder to combobox and text fields as a field-specific property.

      Common complex field properties

      https://git.magnolia-cms.com/projects/PLATFORM/repos/ui/browse/magnolia-ui-framework/src/main/java/info/magnolia/ui/field/ConfiguredComplexPropertyDefinition.java

      • name
      • class
      • $type
      • label
      • description
      • i18n
      • styleName
      • itemProvider

      Checklists

        Acceptance criteria

        Attachments

          Issue Links

            Activity

              People

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

                Dates

                  Created:
                  Updated:
                  Resolved:

                  Checklists

                    Task DoR