Open History to see the last commit
1---
2id: UseField
3title: UseField
4---
5β
6# Type Alias: UseField()\<TParentData, TFormValidator\>
7β
8```ts
9type UseField<TParentData, TFormValidator>: <TName, TFieldValidator, TData>(opts) => FieldApi<TParentData, TName, TFieldValidator, TFormValidator, TData>;
10```
11β
12A type representing a hook for using a field in a form with the given form data type.
13β
14A function that takes an optional object with a `name` property and field options, and returns a `FieldApi` instance for the specified field.
15β
16## Type Parameters
17β
18β’ **TParentData**
19β
20β’ **TFormValidator** *extends* `Validator`\<`TParentData`, `unknown`\> \| `undefined` = `undefined`
21β
22## Type Parameters
23β
24β’ **TName** *extends* `DeepKeys`\<`TParentData`\>
25β
26β’ **TFieldValidator** *extends* `Validator`\<`DeepValue`\<`TParentData`, `TName`\>, `unknown`\> \| `undefined` = `undefined`
27β
28β’ **TData** *extends* `DeepValue`\<`TParentData`, `TName`\> = `DeepValue`\<`TParentData`, `TName`\>
29β
30## Parameters
31β
32β’ **opts**: `Omit`\<`UseFieldOptions`\<`TParentData`, `TName`, `TFieldValidator`, `TFormValidator`, `TData`\>, `"form"`\>
33β
34## Returns
35β
36`FieldApi`\<`TParentData`, `TName`, `TFieldValidator`, `TFormValidator`, `TData`\>
37β
38## Defined in
39β
40[useField.tsx:25](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/react-form/src/useField.tsx#L25)