interface / @typed/ui

Form.FormOptions

Options for the state-explicit form root.

Learn this UI primitive →

Package version
1.0.0-beta.13
Category
Form roots
Since
1.0.0
Member of
Form

Import

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

Access Form.FormOptions 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 FormOptions<Values extends object, E = never, R = never> extends Dom.HostOptions<HTMLFormElement> {
    readonly state: FormState<Values>;
    readonly content: Renderable.Any;
    readonly onValidSubmit?: ValidSubmitHandler<Values, E, R>;
}

Property: content

Controls and other renderable form content.

Property: onValidSubmit

Callback invoked with decoded values only after successful validation.

Property: state

Hydrated renderer-independent state owned outside the form renderer.

Other public imports

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

Source