Standard Schema Forms

Headless Standard Schema Forms; covers Standard Schema V1, TanStack Form, Formwerk.

API

formatFormFieldName

Convert a Standard Schema issue path into a conventional HTML field name.

function formatFormFieldName(path: readonly FormPathKey[]): string

normalizeStandardSchemaIssues

Convert Standard Schema issues into normalized field errors.

function normalizeStandardSchemaIssues( issues: readonly StandardSchemaV1.Issue[], options: FormFieldErrorOptions = {}, ): readonly FormFieldError[]

createFormErrorSummaryFields

Convert normalized field errors into unique fields for the error summary.

function createFormErrorSummaryFields( errors: readonly FormFieldError[], options: FormErrorSummaryFieldOptions = {}, ): readonly ErrorSummaryField[]

normalizeStandardSchemaResult

Normalize a Standard Schema validation result for form fields and summaries.

function normalizeStandardSchemaResult<Output>( result: StandardSchemaV1.Result<Output>, options: StandardSchemaValidationOptions = {}, ): FormValidationResult<Output>

validateStandardSchema

Validate a Standard Schema and normalize the result for form consumers.

async function validateStandardSchema<Input, Output>( schema: StandardSchemaV1<Input, Output>, value: Input, options: StandardSchemaValidationOptions = {}, ): Promise<FormValidationResult<Output>>

useFormField

Create normalized field state whose invalid flag can feed existing field wiring.

function useFormField(options: FormFieldOptions): FormFieldController

useFormErrorSummary

Create error-summary fields from normalized form errors.

function useFormErrorSummary( options: FormErrorSummaryOptions = {}, ): FormErrorSummaryController

normalizeNativeConstraintErrors

Convert native constraint-validation failures into normalized form errors.

function normalizeNativeConstraintErrors( form: HTMLFormElement, options: NativeConstraintErrorOptions = {}, ): readonly FormFieldError[]

useFormState

Create reactive form state around Standard Schema validation and submission.

function useFormState<Input, Output = Input>( options: FormStateOptions<Input, Output> = {}, ): FormStateController<Input, Output>

Behavior

Normative state x input -> outcome table for the Standard Schema form foundation (@vizejs/ui/form). Every row is proven by the named test in src/families/form/form/form.test.ts; compile-only assertions live in src/families/form/form/form.types.test-d.ts.