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

UseFieldOptions.md

124 lines3.4 KB

1---
2id: UseFieldOptions
3title: UseFieldOptions
4---
5​
6# Interface: UseFieldOptions\<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: [packages/react-form/src/types.ts:20](https://github.com/TanStack/form/blob/main/packages/react-form/src/types.ts#L20)
9​
10The field options.
11​
12## Extends
13​
14- `FieldApiOptions`\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnDynamic`, `TFormOnDynamicAsync`, `TFormOnServer`, `TSubmitMeta`\>.`FieldOptionsMode`
15​
16## Type Parameters
17​
18### TParentData
19​
20`TParentData`
21​
22### TName
23​
24`TName` *extends* `DeepKeys`\<`TParentData`\>
25​
26### TData
27​
28`TData` *extends* `DeepValue`\<`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### TSubmitMeta
107​
108`TSubmitMeta`
109​
110## Properties
111​
112### mode?
113​
114```ts
115optional mode: "value" | "array";
116```
117​
118Defined in: [packages/react-form/src/types.ts:14](https://github.com/TanStack/form/blob/main/packages/react-form/src/types.ts#L14)
119​
120#### Inherited from
121​
122```ts
123FieldOptionsMode.mode
124```