form-builder

Appearance

FormLayout ​

A definition's layout, with every reference resolved, as the builder's getLayout() gives it.

Definition ​

  • FormLayout
    • steps readonly LayoutStep[]: at least one. A layout with items, or none, is one step
    • ui Readonly<Record<string, unknown>> | undefined: the layout's ui, as written

LayoutStep ​

  • LayoutStep
    • step JsonLayoutStep: the step as written
    • definitionPath DefinitionPath: where the step is in the definition
    • children readonly LayoutNode[]
    • fields readonly FieldNode[]: every field with a value placed in the step, in layout order

LayoutNode ​

ts
type LayoutNode = LayoutField | LayoutSection | LayoutRow | LayoutSlot

Every node has the keys of LayoutNodeBase.

LayoutNodeBase ​

  • LayoutNodeBase
    • key string: unique among its siblings, and stable: a key for renderers
    • span number: the columns it takes in its row, 12 outside one

LayoutField ​

  • LayoutField
    • type 'field'
    • node FieldNode: the field, or a display element written in the layout
    • children readonly LayoutNode[]: the layout of a group's fields, or of one item of a list

LayoutSection ​

  • LayoutSection
    • type 'section'
    • section JsonLayoutSection: the section as written
    • definitionPath DefinitionPath
    • children readonly LayoutNode[]

LayoutRow ​

  • LayoutRow
    • type 'row'
    • row JsonLayoutRow: the row as written
    • definitionPath DefinitionPath
    • children readonly LayoutNode[]: its cells

LayoutSlot ​

  • LayoutSlot
    • type 'slot'
    • name string

Guides ​

Types ​