Skip to content
Source
Sign inSign up
TanStack/form
Open History to see the last commit

TanStackFormController.md

153 lines3.4 KB

Class: TanStackFormController<TParentData, TFormValidator>

Type Parameters

• TParentData

• TFormValidator extends Validator<TParentData, unknown> | undefined = undefined

Implements

  • ReactiveController

Constructors

new TanStackFormController()

new TanStackFormController<TParentData, TFormValidator>(host, config?): TanStackFormController<TParentData, TFormValidator>

Parameters

• host: ReactiveControllerHost

• config?: FormOptions<TParentData, TFormValidator>

Returns

TanStackFormController<TParentData, TFormValidator>

Defined in

tanstack-form-controller.ts:93

Properties

api

api: FormApi<TParentData, TFormValidator>;

Defined in

tanstack-form-controller.ts:91

Methods

field()

field<TName, TFieldValidator, TData>(fieldConfig, render): object

Type Parameters

• TName extends string | number

• TFieldValidator extends undefined | Validator<DeepValue<TParentData, TName, IsNullable<TParentData>>, unknown> = undefined

• TData = DeepValue<TParentData, TName, IsNullable<TParentData>>

Parameters

• fieldConfig: FieldOptions<TParentData, TName, TFieldValidator, TFormValidator, TData>

• render: renderCallback<TParentData, TName, TFieldValidator, TFormValidator, TData>

Returns

object

values
values: object;
values.form
form: FormApi<TParentData, TFormValidator>;
values.options
options: FieldOptions<TParentData, TName, TFieldValidator, TFormValidator, TData>;
values.render
render: renderCallback<TParentData, TName, TFieldValidator, TFormValidator, TData>;

Defined in

tanstack-form-controller.ts:112


hostConnected()

hostConnected(): void

Called when the host is connected to the component tree. For custom element hosts, this corresponds to the connectedCallback() lifecycle, which is only called when the component is connected to the document.

Returns

void

Implementation of

ReactiveController.hostConnected

Defined in

tanstack-form-controller.ts:102


hostDisconnected()

hostDisconnected(): void

Called when the host is disconnected from the component tree. For custom element hosts, this corresponds to the disconnectedCallback() lifecycle, which is called the host or an ancestor component is disconnected from the document.

Returns

void

Implementation of

ReactiveController.hostDisconnected

Defined in

tanstack-form-controller.ts:108