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

FieldComponent.md

44 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>({
10 children,
11 ...fieldOptions
12}) => NodeType;
13```
14​
15A type alias representing a field component for a specific form data type.
16​
17## Type Parameters
18​
19β€’ **TParentData**
20​
21β€’ **TFormValidator** *extends* `Validator`\<`TParentData`, `unknown`\> \| `undefined` = `undefined`
22​
23## Type Parameters
24​
25β€’ **TName** *extends* `DeepKeys`\<`TParentData`\>
26​
27β€’ **TFieldValidator** *extends* `Validator`\<`DeepValue`\<`TParentData`, `TName`\>, `unknown`\> \| `undefined` = `undefined`
28​
29β€’ **TData** *extends* `DeepValue`\<`TParentData`, `TName`\> = `DeepValue`\<`TParentData`, `TName`\>
30​
31## Parameters
32​
33β€’ **\{
34 children,
35 ...fieldOptions
36\}**: `Omit`\<`FieldComponentProps`\<`TParentData`, `TName`, `TFieldValidator`, `TFormValidator`, `TData`\>, `"form"`\>
37​
38## Returns
39​
40`NodeType`
41​
42## Defined in
43​
44[useField.tsx:133](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/react-form/src/useField.tsx#L133)