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

FieldComponent.md

38 lines1.1 KB

1---
2id: FieldComponent
3title: FieldComponent
4---
5​
6# Type Alias: FieldComponent()\<TParentData, TFormValidator\>
7​
8```ts
9type FieldComponent<TParentData, TFormValidator>: <TName, TFieldValidator, TData>(fieldOptions, context) => any;
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β€’ **fieldOptions**: `Omit`\<`FieldComponentProps`\<`TParentData`, `TName`, `TFieldValidator`, `TFormValidator`, `TData`\>, `"form"`\>
29​
30β€’ **context**: `SetupContext`\<`object`, `SlotsType`\<`object`\>\>
31​
32## Returns
33​
34`any`
35​
36## Defined in
37​
38[packages/vue-form/src/useField.tsx:117](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/vue-form/src/useField.tsx#L117)