Search documentation

Search by topic, API name, or import path.

GitHub ↗

interface / @typed/ui/index

Form.SchemaBoundRoot

Callable root constructor supplied by a schema-bound form API.

Learn this UI primitive →

Package version
1.0.0-beta.13
Category
Schema-bound components
Since
1.0.0
Member of
Form

Import

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

Access Form.SchemaBoundRoot 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 SchemaBoundRoot<Values extends object> {
    <E, R, const Options extends BoundFormOptions<Values, E, R>, const Host extends HostResult = never>(options: Options, host?: Dom.HostOverride<Dom.HostProps<HTMLFormElement>, Options["content"], Host>): SchemaBoundRootResult<Options, Host>;
}

Call signatures

Creates the native form root that provides its form state to bound descendants.

Other public imports

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

Source