API

@formdef/core exports the functions and types below and nothing else. Each page shows the export's documentation as it ships with the package, so your editor shows the same text on hover.

RegistryCopy Anchor Link

What a form is built from and with.

• createRegistry binds the widgets to the TanStack contexts.
• Registry is what it returns: createForm, Fields, formHook and extendRegistry.
• FormConfig, FieldsOf and LayoutOf type a config, or a part of one, written outside createForm.
• FormProps types the props of a form component, and FormHandle the form an inline layout entry receives.
• InferData is the data type of a schema, and Validation says when the schema runs.

WidgetsCopy Anchor Link

What a widget is written with.

• FieldOf states the value type a widget serves, and FieldApiOf is the field it receives.
• fieldParts wires a control to its field and returns FieldParts, with errorsOf and fieldId for the parts on their own.

StructureCopy Anchor Link

The props of the components that fill the structure slots: BodyProps, SectionProps, RowProps and ArrayFrameProps.