JsonField

One field of a definition.

Definition

• JsonField
  • name string: its key in the value. Every field with a value has one
  • type string: its field type
  • label string: optional
  • description string: optional
  • placeholder string: optional
  • default unknown: optional, its starting value
  • required boolean | { message?: string }: optional
  • rules readonly JsonRule[]: optional
  • ui Record<string, unknown>: optional, for renderers. Never read or checked
  • [prop: string] unknown: the props of its type, like options

Explanation

These keys are among the RESERVED_FIELD_KEYS: a field type's props can't use them. See define your form.

Related

Types

• JsonForm
• JsonRule

Constants

• Reserved keys