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

UseField.md

40 lines1.3 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) => 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)