form-builder

Appearance

FieldNode ​

One field of a definition, with the fields inside it, as the builder's getFieldTree() and getLayout() give it.

Definition ​

  • FieldNode
    • field JsonField: the field as the definition has it
    • type string: its field type, like 'text'
    • role FieldRole: how a renderer shows it
    • kind ValueKind: the kind of its value, or 'none' for a display element
    • itemKind ValueKind | undefined: the kind of the items, for kind array
    • dataPath readonly (string | number)[]: where the value is, with '*' for each list index
    • definitionPath DefinitionPath: where the field is in the definition. Unique
    • children readonly FieldNode[]: the fields of a group, or of one item of a list

FieldRole ​

ts
type FieldRole = 'value' | 'group' | 'array' | 'display'

A value field has an input, a group or an array holds fields, and a display element, like a heading, has no value.

Guides ​

Types ​