Open History to see the last commit
1---
2id: TanStackField
3title: TanStackField
4---
5β
6# Class: TanStackField\<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnDynamic, TFormOnDynamicAsync, TFormOnServer, TSubmitMeta\>
7β
8Defined in: [tanstack-field.ts:37](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L37)
9β
10## Extended by
11β
12- [`TanStackAppField`](TanStackAppField.md)
13β
14## Type Parameters
15β
16### TParentData
17β
18`TParentData`
19β
20### TName
21β
22`TName` *extends* `DeepKeys`\<`TParentData`\>
23β
24### TData
25β
26`TData` *extends* `DeepValue`\<`TParentData`, `TName`\>
27β
28### TOnMount
29β
30`TOnMount` *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\>
31β
32### TOnChange
33β
34`TOnChange` *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\>
35β
36### TOnChangeAsync
37β
38`TOnChangeAsync` *extends* `undefined` \| `FieldAsyncValidateOrFn`\<`TParentData`, `TName`, `TData`\>
39β
40### TOnBlur
41β
42`TOnBlur` *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\>
43β
44### TOnBlurAsync
45β
46`TOnBlurAsync` *extends* `undefined` \| `FieldAsyncValidateOrFn`\<`TParentData`, `TName`, `TData`\>
47β
48### TOnSubmit
49β
50`TOnSubmit` *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\>
51β
52### TOnSubmitAsync
53β
54`TOnSubmitAsync` *extends* `undefined` \| `FieldAsyncValidateOrFn`\<`TParentData`, `TName`, `TData`\>
55β
56### TOnDynamic
57β
58`TOnDynamic` *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\>
59β
60### TOnDynamicAsync
61β
62`TOnDynamicAsync` *extends* `undefined` \| `FieldAsyncValidateOrFn`\<`TParentData`, `TName`, `TData`\>
63β
64### TFormOnMount
65β
66`TFormOnMount` *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\>
67β
68### TFormOnChange
69β
70`TFormOnChange` *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\>
71β
72### TFormOnChangeAsync
73β
74`TFormOnChangeAsync` *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\>
75β
76### TFormOnBlur
77β
78`TFormOnBlur` *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\>
79β
80### TFormOnBlurAsync
81β
82`TFormOnBlurAsync` *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\>
83β
84### TFormOnSubmit
85β
86`TFormOnSubmit` *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\>
87β
88### TFormOnSubmitAsync
89β
90`TFormOnSubmitAsync` *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\>
91β
92### TFormOnDynamic
93β
94`TFormOnDynamic` *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\>
95β
96### TFormOnDynamicAsync
97β
98`TFormOnDynamicAsync` *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\>
99β
100### TFormOnServer
101β
102`TFormOnServer` *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\>
103β
104### TSubmitMeta
105β
106`TSubmitMeta`
107β
108## Implements
109β
110- `OnInit`
111β
112## Constructors
113β
114### Constructor
115β
116```ts
117new TanStackField<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnDynamic, TFormOnDynamicAsync, TFormOnServer, TSubmitMeta>(): TanStackField<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnDynamic, TFormOnDynamicAsync, TFormOnServer, TSubmitMeta>;
118```
119β
120Defined in: [tanstack-field.ts:223](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L223)
121β
122#### Returns
123β
124`TanStackField`\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnDynamic`, `TFormOnDynamicAsync`, `TFormOnServer`, `TSubmitMeta`\>
125β
126## Properties
127β
128### \_api
129β
130```ts
131_api: Signal<FieldApi<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnDynamic, TFormOnDynamicAsync, TFormOnServer, TSubmitMeta>>;
132```
133β
134Defined in: [tanstack-field.ts:150](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L150)
135β
136***
137β
138### asyncAlways
139β
140```ts
141asyncAlways: InputSignalWithTransform<boolean, unknown>;
142```
143β
144Defined in: [tanstack-field.ts:75](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L75)
145β
146***
147β
148### asyncDebounceMs
149β
150```ts
151asyncDebounceMs: InputSignalWithTransform<number, unknown>;
152```
153β
154Defined in: [tanstack-field.ts:72](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L72)
155β
156***
157β
158### cd
159β
160```ts
161cd: ChangeDetectorRef;
162```
163β
164Defined in: [tanstack-field.ts:237](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L237)
165β
166***
167β
168### defaultMeta
169β
170```ts
171defaultMeta: InputSignal<
172 | Partial<FieldMeta<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnDynamic, TFormOnDynamicAsync>>
173| undefined>;
174```
175β
176Defined in: [tanstack-field.ts:117](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L117)
177β
178***
179β
180### defaultValue
181β
182```ts
183defaultValue: InputSignal<NoInfer<TData> | undefined>;
184```
185β
186Defined in: [tanstack-field.ts:71](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L71)
187β
188***
189β
190### disableErrorFlat
191β
192```ts
193disableErrorFlat: InputSignal<boolean | undefined>;
194```
195β
196Defined in: [tanstack-field.ts:148](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L148)
197β
198***
199β
200### injector
201β
202```ts
203injector: Injector;
204```
205β
206Defined in: [tanstack-field.ts:221](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L221)
207β
208***
209β
210### listeners
211β
212```ts
213listeners: InputSignal<
214 | NoInfer<FieldListeners<TParentData, TName, TData>>
215| undefined>;
216```
217β
218Defined in: [tanstack-field.ts:116](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L116)
219β
220***
221β
222### mode
223β
224```ts
225mode: InputSignal<"value" | "array" | undefined>;
226```
227β
228Defined in: [tanstack-field.ts:146](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L146)
229β
230***
231β
232### name
233β
234```ts
235name: InputSignal<TName>;
236```
237β
238Defined in: [tanstack-field.ts:70](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L70)
239β
240***
241β
242### options
243β
244```ts
245options: Signal<FieldApiOptions<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnDynamic, TFormOnDynamicAsync, TFormOnServer, TSubmitMeta>>;
246```
247β
248Defined in: [tanstack-field.ts:182](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L182)
249β
250***
251β
252### tanstackField
253β
254```ts
255tanstackField: InputSignal<FormApi<TParentData, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnDynamic, TFormOnDynamicAsync, TFormOnServer, TSubmitMeta>>;
256```
257β
258Defined in: [tanstack-field.ts:78](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L78)
259β
260***
261β
262### validators
263β
264```ts
265validators: InputSignal<
266 | NoInfer<FieldValidators<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync>>
267| undefined>;
268```
269β
270Defined in: [tanstack-field.ts:96](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L96)
271β
272## Accessors
273β
274### api
275β
276#### Get Signature
277β
278```ts
279get api(): FieldApi<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnDynamic, TFormOnDynamicAsync, TFormOnServer, TSubmitMeta>;
280```
281β
282Defined in: [tanstack-field.ts:154](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L154)
283β
284##### Returns
285β
286`FieldApi`\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnDynamic`, `TFormOnDynamicAsync`, `TFormOnServer`, `TSubmitMeta`\>
287β
288## Methods
289β
290### ngOnInit()
291β
292```ts
293ngOnInit(): void;
294```
295β
296Defined in: [tanstack-field.ts:239](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L239)
297β
298A callback method that is invoked immediately after the
299default change detector has checked the directive's
300data-bound properties for the first time,
301and before any of the view or content children have been checked.
302It is invoked only once when the directive is instantiated.
303β
304#### Returns
305β
306`void`
307β
308#### Implementation of
309β
310```ts
311OnInit.ngOnInit
312```