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

Field.md

120 lines3.4 KB

1---
2id: Field
3title: Field
4---
5​
6# Variable: Field()
7​
8```ts
9const Field: <TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnDynamic, TFormOnDynamicAsync, TFormOnServer, TPatentSubmitMeta>(__namedParameters) => ReactNode | Promise<ReactNode>;
10```
11​
12Defined in: [packages/react-form/src/useField.tsx:688](https://github.com/TanStack/form/blob/main/packages/react-form/src/useField.tsx#L688)
13​
14A function component that takes field options and a render function as children and returns a React component.
15​
16The `Field` component uses the `useField` hook internally to manage the field instance.
17​
18## Type Parameters
19​
20### TParentData
21​
22`TParentData`
23​
24### TName
25​
26`TName` *extends* `string`
27​
28### TData
29​
30`TData`
31​
32### TOnMount
33​
34`TOnMount` *extends* `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\> \| `undefined`
35​
36### TOnChange
37​
38`TOnChange` *extends* `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\> \| `undefined`
39​
40### TOnChangeAsync
41​
42`TOnChangeAsync` *extends* `FieldAsyncValidateOrFn`\<`TParentData`, `TName`, `TData`\> \| `undefined`
43​
44### TOnBlur
45​
46`TOnBlur` *extends* `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\> \| `undefined`
47​
48### TOnBlurAsync
49​
50`TOnBlurAsync` *extends* `FieldAsyncValidateOrFn`\<`TParentData`, `TName`, `TData`\> \| `undefined`
51​
52### TOnSubmit
53​
54`TOnSubmit` *extends* `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\> \| `undefined`
55​
56### TOnSubmitAsync
57​
58`TOnSubmitAsync` *extends* `FieldAsyncValidateOrFn`\<`TParentData`, `TName`, `TData`\> \| `undefined`
59​
60### TOnDynamic
61​
62`TOnDynamic` *extends* `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\> \| `undefined`
63​
64### TOnDynamicAsync
65​
66`TOnDynamicAsync` *extends* `FieldAsyncValidateOrFn`\<`TParentData`, `TName`, `TData`\> \| `undefined`
67​
68### TFormOnMount
69​
70`TFormOnMount` *extends* `FormValidateOrFn`\<`TParentData`\> \| `undefined`
71​
72### TFormOnChange
73​
74`TFormOnChange` *extends* `FormValidateOrFn`\<`TParentData`\> \| `undefined`
75​
76### TFormOnChangeAsync
77​
78`TFormOnChangeAsync` *extends* `FormAsyncValidateOrFn`\<`TParentData`\> \| `undefined`
79​
80### TFormOnBlur
81​
82`TFormOnBlur` *extends* `FormValidateOrFn`\<`TParentData`\> \| `undefined`
83​
84### TFormOnBlurAsync
85​
86`TFormOnBlurAsync` *extends* `FormAsyncValidateOrFn`\<`TParentData`\> \| `undefined`
87​
88### TFormOnSubmit
89​
90`TFormOnSubmit` *extends* `FormValidateOrFn`\<`TParentData`\> \| `undefined`
91​
92### TFormOnSubmitAsync
93​
94`TFormOnSubmitAsync` *extends* `FormAsyncValidateOrFn`\<`TParentData`\> \| `undefined`
95​
96### TFormOnDynamic
97​
98`TFormOnDynamic` *extends* `FormValidateOrFn`\<`TParentData`\> \| `undefined`
99​
100### TFormOnDynamicAsync
101​
102`TFormOnDynamicAsync` *extends* `FormAsyncValidateOrFn`\<`TParentData`\> \| `undefined`
103​
104### TFormOnServer
105​
106`TFormOnServer` *extends* `FormAsyncValidateOrFn`\<`TParentData`\> \| `undefined`
107​
108### TPatentSubmitMeta
109​
110`TPatentSubmitMeta`
111​
112## Parameters
113​
114### \_\_namedParameters
115​
116`FieldComponentProps`\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnDynamic`, `TFormOnDynamicAsync`, `TFormOnServer`, `TPatentSubmitMeta`\>
117​
118## Returns
119​
120`ReactNode` \| `Promise`\<`ReactNode`\>