Open History to see the last commit
1---
2id: TanStackFormController
3title: TanStackFormController
4---
5β
6# Class: TanStackFormController\<TParentData, TFormValidator\>
7β
8## Type Parameters
9β
10β’ **TParentData**
11β
12β’ **TFormValidator** *extends* `Validator`\<`TParentData`, `unknown`\> \| `undefined` = `undefined`
13β
14## Implements
15β
16- `ReactiveController`
17β
18## Constructors
19β
20### new TanStackFormController()
21β
22```ts
23new TanStackFormController<TParentData, TFormValidator>(host, config?): TanStackFormController<TParentData, TFormValidator>
24```
25β
26#### Parameters
27β
28β’ **host**: `ReactiveControllerHost`
29β
30β’ **config?**: `FormOptions`\<`TParentData`, `TFormValidator`\>
31β
32#### Returns
33β
34[`TanStackFormController`](TanStackFormController.md)\<`TParentData`, `TFormValidator`\>
35β
36#### Defined in
37β
38[tanstack-form-controller.ts:93](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/lit-form/src/tanstack-form-controller.ts#L93)
39β
40## Properties
41β
42### api
43β
44```ts
45api: FormApi<TParentData, TFormValidator>;
46```
47β
48#### Defined in
49β
50[tanstack-form-controller.ts:91](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/lit-form/src/tanstack-form-controller.ts#L91)
51β
52## Methods
53β
54### field()
55β
56```ts
57field<TName, TFieldValidator, TData>(fieldConfig, render): object
58```
59β
60#### Type Parameters
61β
62β’ **TName** *extends* `string` \| `number`
63β
64β’ **TFieldValidator** *extends* `undefined` \| `Validator`\<`DeepValue`\<`TParentData`, `TName`, `IsNullable`\<`TParentData`\>\>, `unknown`\> = `undefined`
65β
66β’ **TData** = `DeepValue`\<`TParentData`, `TName`, `IsNullable`\<`TParentData`\>\>
67β
68#### Parameters
69β
70β’ **fieldConfig**: `FieldOptions`\<`TParentData`, `TName`, `TFieldValidator`, `TFormValidator`, `TData`\>
71β
72β’ **render**: `renderCallback`\<`TParentData`, `TName`, `TFieldValidator`, `TFormValidator`, `TData`\>
73β
74#### Returns
75β
76`object`
77β
78##### values
79β
80```ts
81values: object;
82```
83β
84##### values.form
85β
86```ts
87form: FormApi<TParentData, TFormValidator>;
88```
89β
90##### values.options
91β
92```ts
93options: FieldOptions<TParentData, TName, TFieldValidator, TFormValidator, TData>;
94```
95β
96##### values.render
97β
98```ts
99render: renderCallback<TParentData, TName, TFieldValidator, TFormValidator, TData>;
100```
101β
102#### Defined in
103β
104[tanstack-form-controller.ts:112](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/lit-form/src/tanstack-form-controller.ts#L112)
105β
106***
107β
108### hostConnected()
109β
110```ts
111hostConnected(): void
112```
113β
114Called when the host is connected to the component tree. For custom
115element hosts, this corresponds to the `connectedCallback()` lifecycle,
116which is only called when the component is connected to the document.
117β
118#### Returns
119β
120`void`
121β
122#### Implementation of
123β
124`ReactiveController.hostConnected`
125β
126#### Defined in
127β
128[tanstack-form-controller.ts:102](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/lit-form/src/tanstack-form-controller.ts#L102)
129β
130***
131β
132### hostDisconnected()
133β
134```ts
135hostDisconnected(): void
136```
137β
138Called when the host is disconnected from the component tree. For custom
139element hosts, this corresponds to the `disconnectedCallback()` lifecycle,
140which is called the host or an ancestor component is disconnected from the
141document.
142β
143#### Returns
144β
145`void`
146β
147#### Implementation of
148β
149`ReactiveController.hostDisconnected`
150β
151#### Defined in
152β
153[tanstack-form-controller.ts:108](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/lit-form/src/tanstack-form-controller.ts#L108)