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

UseFieldOptionsBound.md

78 lines2.0 KB

1---
2id: UseFieldOptionsBound
3title: UseFieldOptionsBound
4---
5​
6# Interface: UseFieldOptionsBound\<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync\>
7​
8Defined in: [packages/react-form/src/types.ts:81](https://github.com/TanStack/form/blob/main/packages/react-form/src/types.ts#L81)
9​
10## Extends
11​
12- `FieldOptions`\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`\>.`FieldOptionsMode`
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## Properties
65​
66### mode?
67​
68```ts
69optional mode: "value" | "array";
70```
71​
72Defined in: [packages/react-form/src/types.ts:14](https://github.com/TanStack/form/blob/main/packages/react-form/src/types.ts#L14)
73​
74#### Inherited from
75​
76```ts
77FieldOptionsMode.mode
78```