Open History to see the last commit
1---
2id: TanStackAppField
3title: TanStackAppField
4---
5β
6# Class: TanStackAppField\<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: [app-field.ts:20](https://github.com/TanStack/form/blob/main/packages/angular-form/src/app-field.ts#L20)
9β
10## Extends
11β
12- [`TanStackField`](TanStackField.md)\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnDynamic`, `TFormOnDynamicAsync`, `TFormOnServer`, `TSubmitMeta`\>
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## Constructors
109β
110### Constructor
111β
112```ts
113new TanStackAppField<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnDynamic, TFormOnDynamicAsync, TFormOnServer, TSubmitMeta>(): TanStackAppField<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnDynamic, TFormOnDynamicAsync, TFormOnServer, TSubmitMeta>;
114```
115β
116Defined in: [app-field.ts:79](https://github.com/TanStack/form/blob/main/packages/angular-form/src/app-field.ts#L79)
117β
118#### Returns
119β
120`TanStackAppField`\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnDynamic`, `TFormOnDynamicAsync`, `TFormOnServer`, `TSubmitMeta`\>
121β
122#### Overrides
123β
124[`TanStackField`](TanStackField.md).[`constructor`](TanStackField.md#constructor)
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#### Inherited from
137β
138[`TanStackField`](TanStackField.md).[`_api`](TanStackField.md#_api)
139β
140***
141β
142### asyncAlways
143β
144```ts
145asyncAlways: InputSignalWithTransform<boolean, unknown>;
146```
147β
148Defined in: [tanstack-field.ts:75](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L75)
149β
150#### Inherited from
151β
152[`TanStackField`](TanStackField.md).[`asyncAlways`](TanStackField.md#asyncalways)
153β
154***
155β
156### asyncDebounceMs
157β
158```ts
159asyncDebounceMs: InputSignalWithTransform<number, unknown>;
160```
161β
162Defined in: [tanstack-field.ts:72](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L72)
163β
164#### Inherited from
165β
166[`TanStackField`](TanStackField.md).[`asyncDebounceMs`](TanStackField.md#asyncdebouncems)
167β
168***
169β
170### base
171β
172```ts
173base: TanStackFieldInjectable<any>;
174```
175β
176Defined in: [app-field.ts:77](https://github.com/TanStack/form/blob/main/packages/angular-form/src/app-field.ts#L77)
177β
178***
179β
180### cd
181β
182```ts
183cd: ChangeDetectorRef;
184```
185β
186Defined in: [tanstack-field.ts:237](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L237)
187β
188#### Inherited from
189β
190[`TanStackField`](TanStackField.md).[`cd`](TanStackField.md#cd)
191β
192***
193β
194### defaultMeta
195β
196```ts
197defaultMeta: InputSignal<
198 | Partial<FieldMeta<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnDynamic, TFormOnDynamicAsync>>
199| undefined>;
200```
201β
202Defined in: [tanstack-field.ts:117](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L117)
203β
204#### Inherited from
205β
206[`TanStackField`](TanStackField.md).[`defaultMeta`](TanStackField.md#defaultmeta)
207β
208***
209β
210### defaultValue
211β
212```ts
213defaultValue: InputSignal<NoInfer<TData> | undefined>;
214```
215β
216Defined in: [tanstack-field.ts:71](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L71)
217β
218#### Inherited from
219β
220[`TanStackField`](TanStackField.md).[`defaultValue`](TanStackField.md#defaultvalue)
221β
222***
223β
224### disableErrorFlat
225β
226```ts
227disableErrorFlat: InputSignal<boolean | undefined>;
228```
229β
230Defined in: [tanstack-field.ts:148](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L148)
231β
232#### Inherited from
233β
234[`TanStackField`](TanStackField.md).[`disableErrorFlat`](TanStackField.md#disableerrorflat)
235β
236***
237β
238### injector
239β
240```ts
241injector: Injector;
242```
243β
244Defined in: [tanstack-field.ts:221](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L221)
245β
246#### Inherited from
247β
248[`TanStackField`](TanStackField.md).[`injector`](TanStackField.md#injector)
249β
250***
251β
252### listeners
253β
254```ts
255listeners: InputSignal<
256 | NoInfer<FieldListeners<TParentData, TName, TData>>
257| undefined>;
258```
259β
260Defined in: [tanstack-field.ts:116](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L116)
261β
262#### Inherited from
263β
264[`TanStackField`](TanStackField.md).[`listeners`](TanStackField.md#listeners)
265β
266***
267β
268### mode
269β
270```ts
271mode: InputSignal<"value" | "array" | undefined>;
272```
273β
274Defined in: [tanstack-field.ts:146](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L146)
275β
276#### Inherited from
277β
278[`TanStackField`](TanStackField.md).[`mode`](TanStackField.md#mode)
279β
280***
281β
282### name
283β
284```ts
285name: InputSignal<TName>;
286```
287β
288Defined in: [tanstack-field.ts:70](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L70)
289β
290#### Inherited from
291β
292[`TanStackField`](TanStackField.md).[`name`](TanStackField.md#name)
293β
294***
295β
296### options
297β
298```ts
299options: 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>>;
300```
301β
302Defined in: [tanstack-field.ts:182](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L182)
303β
304#### Inherited from
305β
306[`TanStackField`](TanStackField.md).[`options`](TanStackField.md#options)
307β
308***
309β
310### tanstackField
311β
312```ts
313tanstackField: InputSignal<FormApi<TParentData, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnDynamic, TFormOnDynamicAsync, TFormOnServer, TSubmitMeta>>;
314```
315β
316Defined in: [tanstack-field.ts:78](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L78)
317β
318#### Inherited from
319β
320[`TanStackField`](TanStackField.md).[`tanstackField`](TanStackField.md#tanstackfield)
321β
322***
323β
324### validators
325β
326```ts
327validators: InputSignal<
328 | NoInfer<FieldValidators<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync>>
329| undefined>;
330```
331β
332Defined in: [tanstack-field.ts:96](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L96)
333β
334#### Inherited from
335β
336[`TanStackField`](TanStackField.md).[`validators`](TanStackField.md#validators)
337β
338## Accessors
339β
340### api
341β
342#### Get Signature
343β
344```ts
345get 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>;
346```
347β
348Defined in: [tanstack-field.ts:154](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L154)
349β
350##### Returns
351β
352`FieldApi`\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnDynamic`, `TFormOnDynamicAsync`, `TFormOnServer`, `TSubmitMeta`\>
353β
354#### Inherited from
355β
356[`TanStackField`](TanStackField.md).[`api`](TanStackField.md#api)
357β
358## Methods
359β
360### ngOnInit()
361β
362```ts
363ngOnInit(): void;
364```
365β
366Defined in: [tanstack-field.ts:239](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L239)
367β
368A callback method that is invoked immediately after the
369default change detector has checked the directive's
370data-bound properties for the first time,
371and before any of the view or content children have been checked.
372It is invoked only once when the directive is instantiated.
373β
374#### Returns
375β
376`void`
377β
378#### Inherited from
379β
380[`TanStackField`](TanStackField.md).[`ngOnInit`](TanStackField.md#ngoninit)