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

FieldApiOptions.md

266 lines6.5 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:383](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L383)
9​
10## Extends
11​
12- `FieldExtraOptions`\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`\>
13​
14## Type Parameters
15​
16### TParentData
17​
18`TParentData`
19​
20### TName
21​
22`TName` *extends* [`DeepKeys`](../type-aliases/DeepKeys.md)\<`TParentData`\>
23​
24### TData
25​
26`TData` *extends* [`DeepValue`](../type-aliases/DeepValue.md)\<`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### TParentSubmitMeta
105​
106`TParentSubmitMeta`
107​
108## Properties
109​
110### asyncAlways?
111​
112```ts
113optional asyncAlways: boolean;
114```
115​
116Defined in: [packages/form-core/src/types.ts:982](https://github.com/TanStack/form/blob/main/packages/form-core/src/types.ts#L982)
117​
118If `true`, always run async validation, even if there are errors emitted during synchronous validation.
119​
120#### Inherited from
121​
122```ts
123FieldLikeApiOptions.asyncAlways
124```
125​
126***
127​
128### asyncDebounceMs?
129​
130```ts
131optional asyncDebounceMs: number;
132```
133​
134Defined in: [packages/form-core/src/types.ts:978](https://github.com/TanStack/form/blob/main/packages/form-core/src/types.ts#L978)
135​
136The default time to debounce async validation if there is not a more specific debounce time passed.
137​
138#### Inherited from
139​
140```ts
141FieldLikeApiOptions.asyncDebounceMs
142```
143​
144***
145​
146### defaultMeta?
147​
148```ts
149optional defaultMeta: Partial<FieldLikeMeta<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, any, any, any, any, any, any, any, any, any>>;
150```
151​
152Defined in: [packages/form-core/src/types.ts:986](https://github.com/TanStack/form/blob/main/packages/form-core/src/types.ts#L986)
153​
154An optional object with default metadata for the field.
155​
156#### Inherited from
157​
158```ts
159FieldLikeApiOptions.defaultMeta
160```
161​
162***
163​
164### defaultValue?
165​
166```ts
167optional defaultValue: NoInfer<TData>;
168```
169​
170Defined in: [packages/form-core/src/types.ts:974](https://github.com/TanStack/form/blob/main/packages/form-core/src/types.ts#L974)
171​
172An optional default value for the field.
173​
174#### Inherited from
175​
176```ts
177FieldLikeApiOptions.defaultValue
178```
179​
180***
181​
182### disableErrorFlat?
183​
184```ts
185optional disableErrorFlat: boolean;
186```
187​
188Defined in: [packages/form-core/src/types.ts:1014](https://github.com/TanStack/form/blob/main/packages/form-core/src/types.ts#L1014)
189​
190Disable 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.
191​
192#### Inherited from
193​
194```ts
195FieldLikeApiOptions.disableErrorFlat
196```
197​
198***
199​
200### form
201​
202```ts
203form: FormApi<TParentData, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnDynamic, TFormOnDynamicAsync, TFormOnServer, TParentSubmitMeta>;
204```
205​
206Defined in: [packages/form-core/src/types.ts:1094](https://github.com/TanStack/form/blob/main/packages/form-core/src/types.ts#L1094)
207​
208#### Inherited from
209​
210```ts
211FieldLikeApiOptions.form
212```
213​
214***
215​
216### listeners?
217​
218```ts
219optional listeners: FieldListeners<TParentData, TName, TData>;
220```
221​
222Defined in: [packages/form-core/src/FieldApi.ts:325](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L325)
223​
224A list of listeners which attach to the corresponding events
225​
226#### Inherited from
227​
228```ts
229FieldExtraOptions.listeners
230```
231​
232***
233​
234### name
235​
236```ts
237name: TName;
238```
239​
240Defined in: [packages/form-core/src/types.ts:970](https://github.com/TanStack/form/blob/main/packages/form-core/src/types.ts#L970)
241​
242The field name. The type will be `DeepKeys<TParentData>` to ensure your name is a deep key of the parent dataset.
243​
244#### Inherited from
245​
246```ts
247FieldLikeApiOptions.name
248```
249​
250***
251​
252### validators?
253​
254```ts
255optional validators: FieldValidators<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync>;
256```
257​
258Defined in: [packages/form-core/src/FieldApi.ts:307](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L307)
259​
260A list of validators to pass to the field
261​
262#### Inherited from
263​
264```ts
265FieldExtraOptions.validators
266```