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

TanStackAppField.md

380 lines11.7 KB

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)