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

useField.md

40 lines1.2 KB

1---
2id: useField
3title: useField
4---
5​
6# Function: useField()
7​
8```ts
9function useField<TParentData, TName, TFieldValidator, TFormValidator, TData>(opts): FieldApi<TParentData, TName, TFieldValidator, TFormValidator, TData> & ReactFieldApi<TParentData, TFormValidator>
10```
11​
12A hook for managing a field in a form.
13​
14## Type Parameters
15​
16β€’ **TParentData**
17​
18β€’ **TName** *extends* `string` \| `number`
19​
20β€’ **TFieldValidator** *extends* `undefined` \| `Validator`\<`DeepValue`\<`TParentData`, `TName`\>, `unknown`\> = `undefined`
21​
22β€’ **TFormValidator** *extends* `undefined` \| `Validator`\<`TParentData`, `unknown`\> = `undefined`
23​
24β€’ **TData** = `DeepValue`\<`TParentData`, `TName`\>
25​
26## Parameters
27​
28β€’ **opts**: `UseFieldOptions`\<`TParentData`, `TName`, `TFieldValidator`, `TFormValidator`, `TData`\>
29​
30An object with field options.
31​
32## Returns
33​
34`FieldApi`\<`TParentData`, `TName`, `TFieldValidator`, `TFormValidator`, `TData`\> & `ReactFieldApi`\<`TParentData`, `TFormValidator`\>
35​
36The `FieldApi` instance for the specified field.
37​
38## Defined in
39​
40[useField.tsx:49](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/react-form/src/useField.tsx#L49)