[MGNLUI-6319] DOC: Separate tables for common complex and common simple field properties Created: 15/Oct/20  Updated: 30/Nov/20  Resolved: 30/Nov/20

Status: Closed
Project: Magnolia UI
Component/s: None
Affects Version/s: 6.2
Fix Version/s: None

Type: Task Priority: Neutral
Reporter: Ashraf Khamis Assignee: Ashraf Khamis
Resolution: Done Votes: 0
Labels: fields, new-UI-framework, new-form
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Relates
relates to MGNLUI-6239 DOC: Where to place common field prop... Closed
Template:
Acceptance criteria:
Empty
Task DoR:
Empty
Date of First Response:
Epic Link: DOC: Restructure common field properties
Sprint: UI FW 16
Story Points: 5

 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


 Comments   
Comment by Ashraf Khamis [ 25/Nov/20 ]

Reviewed by Roman and Šimon.

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