The UI section of the Fields framework, it consists on a FieldBuilder which receives the data from the backend and iterates through the elements in the object. Each field has the elements described in the FieldData Interface and the possible types are enumerated bellow.

FieldData Interface

PropertyTypeDescription
typeFieldTypesType of the field (Enum).
fieldstringField name.
labelstringLabel for the field.
displayany[any]
css_styleanyCSS style information.
css_classstringCSS class information.
use_ellipsesbooleanFlag to indicate whether to use ellipses.
sortbooleanstring
only_on_highlightbooleanFlag to show only when highlighted.
show_blankbooleanFlag to show when blank.
[x: string]anyAdditional properties allowed.

FieldTypes Enum

NameValue
TEXT'text'
URL'url'
DATE'date'
DATEAGE'date_age'
NUMBER'number'
SIZE'size'
MIME_TYPE'mime_type'
IMAGE'image'
THUMBNAILS'thumbnails'
BOOL'bool'
NESTED'nested'
KEYVALUE'key_value'
KEYVALUETABLE'key_value_table'
TAGS'tags'
CHIP'chip'


Each type has its own Functional Component defined at src/framework/fields/field-components which is where you may modify the way they're displayed at the screen.

Workflow

  • No labels