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

FieldApiOptions.md

246 lines6.9 KB

1---
2id: FieldApiOptions
3title: FieldApiOptions
4---
5​
6# Interface: FieldApiOptions\<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnDynamic, TFormOnDynamicAsync, TFormOnServer, TParentSubmitMeta\>
7​
8Defined in: [packages/form-core/src/FieldApi.ts:487](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L487)
9​
10An object type representing the required options for the FieldApi class.
11​
12## Extends
13​
14- [`FieldOptions`](FieldOptions.md)\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`\>
15​
16## Type Parameters
17​
18### TParentData
19​
20`TParentData`
21​
22### TName
23​
24`TName` *extends* [`DeepKeys`](../type-aliases/DeepKeys.md)\<`TParentData`\>
25​
26### TData
27​
28`TData` *extends* [`DeepValue`](../type-aliases/DeepValue.md)\<`TParentData`, `TName`\>
29​
30### TOnMount
31​
32`TOnMount` *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\>
33​
34### TOnChange
35​
36`TOnChange` *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\>
37​
38### TOnChangeAsync
39​
40`TOnChangeAsync` *extends* `undefined` \| `FieldAsyncValidateOrFn`\<`TParentData`, `TName`, `TData`\>
41​
42### TOnBlur
43​
44`TOnBlur` *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\>
45​
46### TOnBlurAsync
47​
48`TOnBlurAsync` *extends* `undefined` \| `FieldAsyncValidateOrFn`\<`TParentData`, `TName`, `TData`\>
49​
50### TOnSubmit
51​
52`TOnSubmit` *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\>
53​
54### TOnSubmitAsync
55​
56`TOnSubmitAsync` *extends* `undefined` \| `FieldAsyncValidateOrFn`\<`TParentData`, `TName`, `TData`\>
57​
58### TOnDynamic
59​
60`TOnDynamic` *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\>
61​
62### TOnDynamicAsync
63​
64`TOnDynamicAsync` *extends* `undefined` \| `FieldAsyncValidateOrFn`\<`TParentData`, `TName`, `TData`\>
65​
66### TFormOnMount
67​
68`TFormOnMount` *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\>
69​
70### TFormOnChange
71​
72`TFormOnChange` *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\>
73​
74### TFormOnChangeAsync
75​
76`TFormOnChangeAsync` *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\>
77​
78### TFormOnBlur
79​
80`TFormOnBlur` *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\>
81​
82### TFormOnBlurAsync
83​
84`TFormOnBlurAsync` *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\>
85​
86### TFormOnSubmit
87​
88`TFormOnSubmit` *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\>
89​
90### TFormOnSubmitAsync
91​
92`TFormOnSubmitAsync` *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\>
93​
94### TFormOnDynamic
95​
96`TFormOnDynamic` *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\>
97​
98### TFormOnDynamicAsync
99​
100`TFormOnDynamicAsync` *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\>
101​
102### TFormOnServer
103​
104`TFormOnServer` *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\>
105​
106### TParentSubmitMeta
107​
108`TParentSubmitMeta`
109​
110## Properties
111​
112### asyncAlways?
113​
114```ts
115optional asyncAlways: boolean;
116```
117​
118Defined in: [packages/form-core/src/FieldApi.ts:428](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L428)
119​
120If `true`, always run async validation, even if there are errors emitted during synchronous validation.
121​
122#### Inherited from
123​
124[`FieldOptions`](FieldOptions.md).[`asyncAlways`](FieldOptions.md#asyncalways)
125​
126***
127​
128### asyncDebounceMs?
129​
130```ts
131optional asyncDebounceMs: number;
132```
133​
134Defined in: [packages/form-core/src/FieldApi.ts:424](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L424)
135​
136The default time to debounce async validation if there is not a more specific debounce time passed.
137​
138#### Inherited from
139​
140[`FieldOptions`](FieldOptions.md).[`asyncDebounceMs`](FieldOptions.md#asyncdebouncems)
141​
142***
143​
144### defaultMeta?
145​
146```ts
147optional defaultMeta: Partial<FieldMeta<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, any, any, any, any, any, any, any, any, any>>;
148```
149​
150Defined in: [packages/form-core/src/FieldApi.ts:449](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L449)
151​
152An optional object with default metadata for the field.
153​
154#### Inherited from
155​
156[`FieldOptions`](FieldOptions.md).[`defaultMeta`](FieldOptions.md#defaultmeta)
157​
158***
159​
160### defaultValue?
161​
162```ts
163optional defaultValue: NoInfer<TData>;
164```
165​
166Defined in: [packages/form-core/src/FieldApi.ts:420](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L420)
167​
168An optional default value for the field.
169​
170#### Inherited from
171​
172[`FieldOptions`](FieldOptions.md).[`defaultValue`](FieldOptions.md#defaultvalue)
173​
174***
175​
176### disableErrorFlat?
177​
178```ts
179optional disableErrorFlat: boolean;
180```
181​
182Defined in: [packages/form-core/src/FieldApi.ts:481](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L481)
183​
184Disable the `flat(1)` operation on `field.errors`. This is useful if you want to keep the error structure as is. Not suggested for most use-cases.
185​
186#### Inherited from
187​
188[`FieldOptions`](FieldOptions.md).[`disableErrorFlat`](FieldOptions.md#disableerrorflat)
189​
190***
191​
192### form
193​
194```ts
195form: FormApi<TParentData, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnDynamic, TFormOnDynamicAsync, TFormOnServer, TParentSubmitMeta>;
196```
197​
198Defined in: [packages/form-core/src/FieldApi.ts:551](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L551)
199​
200***
201​
202### listeners?
203​
204```ts
205optional listeners: FieldListeners<TParentData, TName, TData>;
206```
207​
208Defined in: [packages/form-core/src/FieldApi.ts:477](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L477)
209​
210A list of listeners which attach to the corresponding events
211​
212#### Inherited from
213​
214[`FieldOptions`](FieldOptions.md).[`listeners`](FieldOptions.md#listeners)
215​
216***
217​
218### name
219​
220```ts
221name: TName;
222```
223​
224Defined in: [packages/form-core/src/FieldApi.ts:416](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L416)
225​
226The field name. The type will be `DeepKeys<TParentData>` to ensure your name is a deep key of the parent dataset.
227​
228#### Inherited from
229​
230[`FieldOptions`](FieldOptions.md).[`name`](FieldOptions.md#name)
231​
232***
233​
234### validators?
235​
236```ts
237optional validators: FieldValidators<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync>;
238```
239​
240Defined in: [packages/form-core/src/FieldApi.ts:432](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L432)
241​
242A list of validators to pass to the field
243​
244#### Inherited from
245​
246[`FieldOptions`](FieldOptions.md).[`validators`](FieldOptions.md#validators)