interface / @typed/ui/index

Form.SchemaBoundStateOptions

Optional state metadata for SchemaBoundForm.state.

Learn this UI primitive →

Package version
1.0.0-beta.7
Category
Component options
Since
1.0.0
Member of
Form

Import

import { Form } from "@typed/ui/index";

Access Form.SchemaBoundStateOptions through the imported Form export. Its declaration below describes the member.

This public exposure is a re-export. Its import path is supported; declaration documentation is shared with the other public exposures below.

Signatures

export interface SchemaBoundStateOptions<Values extends object> {
    readonly id?: string;
    readonly defaultValues?: Values;
    readonly errors?: Partial<Record<keyof Values & string, string>>;
    readonly meta?: Partial<Record<keyof Values & string, FieldMeta>>;
    readonly submitting?: boolean;
}

Property: defaultValues

Exact reset-baseline reference, defaulting to the same object passed as initial values.

Property: errors

Initial field validation messages.

Property: id

Stable hydration and accessibility relationship ID; required for deterministic SSR ordering.

Property: meta

Initial dirty/touched metadata.

Property: submitting

Whether validation or the returned submit Effect is running.

Other public imports

These import paths expose the same declaration. Each page retains its own public name and signature.

Source