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

CreateField.md

40 lines1.1 KB

1---
2id: CreateField
3title: CreateField
4---
5​
6# Type Alias: CreateField()\<TParentData, TFormValidator\>
7​
8```ts
9type CreateField<TParentData, TFormValidator>: <TName, TFieldValidator, TData>(opts) => () => FieldApi<TParentData, TName, TFieldValidator, TFormValidator, TData> & SolidFieldApi<TParentData, TFormValidator>;
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**
29​
30## Returns
31​
32`Function`
33​
34### Returns
35​
36`FieldApi`\<`TParentData`, `TName`, `TFieldValidator`, `TFormValidator`, `TData`\> & `SolidFieldApi`\<`TParentData`, `TFormValidator`\>
37​
38## Defined in
39​
40[createField.tsx:29](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/solid-form/src/createField.tsx#L29)