TypedForm

A definition written against one builder's registries, as defineForm() takes it. It is also a JsonForm.

Generics

• TFieldTypes extends Record<string, FieldTypeDef>
• TRules extends Record<string, RuleDef>
• TFormRules extends Record<string, FormRuleDef>
• TExtensionProps extends ExtensionProps

Definition

• TypedForm
  • version '1'
  • fields readonly TypedField[]
  • formRules readonly TypedFormRule[]: optional
  • layout TypedLayout: optional
  • $schema string: optional

Explanation

The package also exports the types it is made of:

• TypedField: a field of a registered type, with that type's props, the keys every field takes, and the keys extensions add.
• TypedRule and TypedFormRule: a registered rule or form rule, with its params.
• TypedLayout and TypedLayoutItem: the layout, with display elements typed by their props.
• ExtensionProps and NoExtensionProps: the keys a builder's extensions add to fields, and to steps and sections.

Related

Guides

• TypeScript