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) => object;
10```
11β
12## Type Parameters
13β
14β’ **TParentData**
15β
16β’ **TFormValidator** *extends* `Validator`\<`TParentData`, `unknown`\> \| `undefined` = `undefined`
17β
18## Type Parameters
19β
20β’ **TName** *extends* `DeepKeys`\<`TParentData`\>
21β
22β’ **TFieldValidator** *extends* `Validator`\<`DeepValue`\<`TParentData`, `TName`\>, `unknown`\> \| `undefined` = `undefined`
23β
24β’ **TData** *extends* `DeepValue`\<`TParentData`, `TName`\> = `DeepValue`\<`TParentData`, `TName`\>
25β
26## Parameters
27β
28β’ **opts**: `Omit`\<`UseFieldOptions`\<`TParentData`, `TName`, `TFieldValidator`, `TFormValidator`, `TData`\>, `"form"`\>
29β
30## Returns
31β
32`object`
33β
34### api
35β
36```ts
37api: FieldApi<TParentData, TName, TFieldValidator, TFormValidator, TData> & VueFieldApi<TParentData, TFormValidator>;
38```
39β
40### state
41β
42```ts
43state: Readonly<Ref<FieldApi<TParentData, TName, TFieldValidator, TFormValidator, TData>["state"]>>;
44```
45β
46## Defined in
47β
48[packages/vue-form/src/useField.tsx:17](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/vue-form/src/useField.tsx#L17)