interface / @typed/ui/Form

State

Serializable renderer-independent state of a form.

Learn this UI primitive →

Package version
1.0.0-beta.13
Category
State models
Since
1.0.0

Import

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

Signatures

export interface State<Values extends object = object> {
    readonly values: Values;
    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 baseline reference used by reset and retained independently from current values.

Property: errors

Current validation messages keyed by field name.

Property: meta

Dirty/touched metadata keyed by field name.

Property: submitting

Whether validation or the returned submit Effect is running.

Property: values

Current decoded field values.

Other public imports

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

Source