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

TanStackField.md

312 lines9.6 KB

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```