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

UseField.md

48 lines1.2 KB

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)