interface / @typed/ui

Form.BoundFormOptions

Options accepted by a schema-bound 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.BoundFormOptions 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 BoundFormOptions<Values extends object, E = never, R = never> extends Dom.HostOptions<HTMLFormElement> {
    readonly form: FormState<Values>;
    readonly content: Renderable.Any;
    readonly onValidSubmit?: ValidSubmitHandler<Values, E, R>;
}

Property: content

Schema-bound controls and other renderable form content.

Property: form

State previously created by the bound API’s state constructor.

Property: onValidSubmit

Callback invoked with decoded values only after successful validation.

Other public imports

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

Source