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

LitFieldMethods.md

92 lines2.1 KB

1---
2id: LitFieldMethods
3title: LitFieldMethods
4---
5​
6Defined in: [tanstack-form-controller.ts:81](https://github.com/TanStack/form/blob/main/packages/lit-form/src/tanstack-form-controller.ts#L81)
7​
8## Type Parameters
9​
10### TFieldData
11​
12`TFieldData`
13​
14### TGroupFieldError
15​
16`TGroupFieldError`
17​
18### TFormData
19​
20`TFormData`
21​
22### TFormErrorTypes
23​
24`TFormErrorTypes` *extends* `FormErrorTypes`
25​
26## Methods
27​
28### arrayField()
29​
30```ts
31arrayField<TFieldName, TFieldValidators>(options, render): unknown;
32```
33​
34Defined in: [tanstack-form-controller.ts:117](https://github.com/TanStack/form/blob/main/packages/lit-form/src/tanstack-form-controller.ts#L117)
35​
36#### Type Parameters
37​
38##### TFieldName
39​
40`TFieldName` *extends* `never`
41​
42##### TFieldValidators
43​
44`TFieldValidators` *extends* `FieldValidators`\<`TFieldData`, `TFieldName`, `DeepValue`\<`TFieldData`, `TFieldName`\>\>
45​
46#### Parameters
47​
48##### options
49​
50`LitFieldOptions`\<`TFieldData`, `TFieldName`, `DeepValue`\<`TFieldData`, `TFieldName`\>, `TFieldValidators`, `TGroupFieldError`, `TFormData`, `TFormErrorTypes`\>
51​
52##### render
53​
54`RenderCallback`\<`LitFieldRenderApi`\<`TFieldData`, `TFieldName`, `DeepValue`\<`TFieldData`, `TFieldName`\>, `TFieldValidators`, `TGroupFieldError`, `TFormData`, `TFormErrorTypes`\>\>
55​
56#### Returns
57​
58`unknown`
59​
60***
61​
62### field()
63​
64```ts
65field<TFieldName, TFieldValidators>(options, render): unknown;
66```
67​
68Defined in: [tanstack-form-controller.ts:87](https://github.com/TanStack/form/blob/main/packages/lit-form/src/tanstack-form-controller.ts#L87)
69​
70#### Type Parameters
71​
72##### TFieldName
73​
74`TFieldName` *extends* `string`
75​
76##### TFieldValidators
77​
78`TFieldValidators` *extends* `FieldValidators`\<`TFieldData`, `TFieldName`, `DeepValue`\<`TFieldData`, `TFieldName`\>\>
79​
80#### Parameters
81​
82##### options
83​
84`LitFieldOptions`\<`TFieldData`, `TFieldName`, `DeepValue`\<`TFieldData`, `TFieldName`\>, `TFieldValidators`, `TGroupFieldError`, `TFormData`, `TFormErrorTypes`\>
85​
86##### render
87​
88`RenderCallback`\<`LitFieldRenderApi`\<`TFieldData`, `TFieldName`, `DeepValue`\<`TFieldData`, `TFieldName`\>, `TFieldValidators`, `TGroupFieldError`, `TFormData`, `TFormErrorTypes`\>\>
89​
90#### Returns
91​
92`unknown`