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

fieldapioptions.md

202 lines6.7 KB

1---
2id: FieldApiOptions
3title: FieldApiOptions
4---
5​
6<!-- DO NOT EDIT: this page is autogenerated from the type comments -->
7​
8# 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\>
9​
10Defined in: [packages/form-core/src/FieldApi.ts:486](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L486)
11​
12An object type representing the required options for the FieldApi class.
13​
14## Extends
15​
16- [`FieldOptions`](../fieldoptions.md)\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`\>
17​
18## Type Parameters
19​
20• **TParentData**
21​
22• **TName** *extends* [`DeepKeys`](../../type-aliases/deepkeys.md)\<`TParentData`\>
23​
24• **TData** *extends* [`DeepValue`](../../type-aliases/deepvalue.md)\<`TParentData`, `TName`\>
25​
26• **TOnMount** *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\>
27​
28• **TOnChange** *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\>
29​
30• **TOnChangeAsync** *extends* `undefined` \| `FieldAsyncValidateOrFn`\<`TParentData`, `TName`, `TData`\>
31​
32• **TOnBlur** *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\>
33​
34• **TOnBlurAsync** *extends* `undefined` \| `FieldAsyncValidateOrFn`\<`TParentData`, `TName`, `TData`\>
35​
36• **TOnSubmit** *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\>
37​
38• **TOnSubmitAsync** *extends* `undefined` \| `FieldAsyncValidateOrFn`\<`TParentData`, `TName`, `TData`\>
39​
40• **TOnDynamic** *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\>
41​
42• **TOnDynamicAsync** *extends* `undefined` \| `FieldAsyncValidateOrFn`\<`TParentData`, `TName`, `TData`\>
43​
44• **TFormOnMount** *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\>
45​
46• **TFormOnChange** *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\>
47​
48• **TFormOnChangeAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\>
49​
50• **TFormOnBlur** *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\>
51​
52• **TFormOnBlurAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\>
53​
54• **TFormOnSubmit** *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\>
55​
56• **TFormOnSubmitAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\>
57​
58• **TFormOnDynamic** *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\>
59​
60• **TFormOnDynamicAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\>
61​
62• **TFormOnServer** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\>
63​
64• **TParentSubmitMeta**
65​
66## Properties
67​
68### asyncAlways?
69​
70```ts
71optional asyncAlways: boolean;
72```
73​
74Defined in: [packages/form-core/src/FieldApi.ts:427](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L427)
75​
76If `true`, always run async validation, even if there are errors emitted during synchronous validation.
77​
78#### Inherited from
79​
80[`FieldOptions`](../fieldoptions.md).[`asyncAlways`](../FieldOptions.md#asyncalways)
81​
82***
83​
84### asyncDebounceMs?
85​
86```ts
87optional asyncDebounceMs: number;
88```
89​
90Defined in: [packages/form-core/src/FieldApi.ts:423](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L423)
91​
92The default time to debounce async validation if there is not a more specific debounce time passed.
93​
94#### Inherited from
95​
96[`FieldOptions`](../fieldoptions.md).[`asyncDebounceMs`](../FieldOptions.md#asyncdebouncems)
97​
98***
99​
100### defaultMeta?
101​
102```ts
103optional defaultMeta: Partial<FieldMeta<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, any, any, any, any, any, any, any, any, any>>;
104```
105​
106Defined in: [packages/form-core/src/FieldApi.ts:448](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L448)
107​
108An optional object with default metadata for the field.
109​
110#### Inherited from
111​
112[`FieldOptions`](../fieldoptions.md).[`defaultMeta`](../FieldOptions.md#defaultmeta)
113​
114***
115​
116### defaultValue?
117​
118```ts
119optional defaultValue: NoInfer<TData>;
120```
121​
122Defined in: [packages/form-core/src/FieldApi.ts:419](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L419)
123​
124An optional default value for the field.
125​
126#### Inherited from
127​
128[`FieldOptions`](../fieldoptions.md).[`defaultValue`](../FieldOptions.md#defaultvalue)
129​
130***
131​
132### disableErrorFlat?
133​
134```ts
135optional disableErrorFlat: boolean;
136```
137​
138Defined in: [packages/form-core/src/FieldApi.ts:480](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L480)
139​
140Disable 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.
141​
142#### Inherited from
143​
144[`FieldOptions`](../fieldoptions.md).[`disableErrorFlat`](../FieldOptions.md#disableerrorflat)
145​
146***
147​
148### form
149​
150```ts
151form: FormApi<TParentData, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnDynamic, TFormOnDynamicAsync, TFormOnServer, TParentSubmitMeta>;
152```
153​
154Defined in: [packages/form-core/src/FieldApi.ts:550](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L550)
155​
156***
157​
158### listeners?
159​
160```ts
161optional listeners: FieldListeners<TParentData, TName, TData>;
162```
163​
164Defined in: [packages/form-core/src/FieldApi.ts:476](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L476)
165​
166A list of listeners which attach to the corresponding events
167​
168#### Inherited from
169​
170[`FieldOptions`](../fieldoptions.md).[`listeners`](../FieldOptions.md#listeners)
171​
172***
173​
174### name
175​
176```ts
177name: TName;
178```
179​
180Defined in: [packages/form-core/src/FieldApi.ts:415](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L415)
181​
182The field name. The type will be `DeepKeys<TParentData>` to ensure your name is a deep key of the parent dataset.
183​
184#### Inherited from
185​
186[`FieldOptions`](../fieldoptions.md).[`name`](../FieldOptions.md#name)
187​
188***
189​
190### validators?
191​
192```ts
193optional validators: FieldValidators<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync>;
194```
195​
196Defined in: [packages/form-core/src/FieldApi.ts:431](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L431)
197​
198A list of validators to pass to the field
199​
200#### Inherited from
201​
202[`FieldOptions`](../fieldoptions.md).[`validators`](../FieldOptions.md#validators)