@@ -3,81 +3,125 @@ id: TanStackField
33title : TanStackField
44---
55
6- <!-- DO NOT EDIT: this page is autogenerated from the type comments -->
7-
86# Class: TanStackField\< TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnDynamic, TFormOnDynamicAsync, TFormOnServer, TSubmitMeta\>
97
108Defined in: [ tanstack-field.ts:37] ( https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L37 )
119
1210## Extended by
1311
14- - [ ` TanStackAppField ` ] ( ../tanstackappfield .md )
12+ - [ ` TanStackAppField ` ] ( ../TanStackAppField .md )
1513
1614## Type Parameters
1715
18- • ** TParentData**
16+ ### TParentData
17+
18+ ` TParentData `
19+
20+ ### TName
21+
22+ ` TName ` * extends* ` DeepKeys ` \< ` TParentData ` \>
23+
24+ ### TData
25+
26+ ` TData ` * extends* ` DeepValue ` \< ` TParentData ` , ` TName ` \>
27+
28+ ### TOnMount
29+
30+ ` TOnMount ` * extends* ` undefined ` \| ` FieldValidateOrFn ` \< ` TParentData ` , ` TName ` , ` TData ` \>
31+
32+ ### TOnChange
33+
34+ ` TOnChange ` * extends* ` undefined ` \| ` FieldValidateOrFn ` \< ` TParentData ` , ` TName ` , ` TData ` \>
35+
36+ ### TOnChangeAsync
37+
38+ ` TOnChangeAsync ` * extends* ` undefined ` \| ` FieldAsyncValidateOrFn ` \< ` TParentData ` , ` TName ` , ` TData ` \>
39+
40+ ### TOnBlur
41+
42+ ` TOnBlur ` * extends* ` undefined ` \| ` FieldValidateOrFn ` \< ` TParentData ` , ` TName ` , ` TData ` \>
43+
44+ ### TOnBlurAsync
45+
46+ ` TOnBlurAsync ` * extends* ` undefined ` \| ` FieldAsyncValidateOrFn ` \< ` TParentData ` , ` TName ` , ` TData ` \>
47+
48+ ### TOnSubmit
49+
50+ ` TOnSubmit ` * extends* ` undefined ` \| ` FieldValidateOrFn ` \< ` TParentData ` , ` TName ` , ` TData ` \>
51+
52+ ### TOnSubmitAsync
53+
54+ ` TOnSubmitAsync ` * extends* ` undefined ` \| ` FieldAsyncValidateOrFn ` \< ` TParentData ` , ` TName ` , ` TData ` \>
55+
56+ ### TOnDynamic
57+
58+ ` TOnDynamic ` * extends* ` undefined ` \| ` FieldValidateOrFn ` \< ` TParentData ` , ` TName ` , ` TData ` \>
59+
60+ ### TOnDynamicAsync
61+
62+ ` TOnDynamicAsync ` * extends* ` undefined ` \| ` FieldAsyncValidateOrFn ` \< ` TParentData ` , ` TName ` , ` TData ` \>
1963
20- • ** TName ** * extends * ` DeepKeys ` \< ` TParentData ` \>
64+ ### TFormOnMount
2165
22- • ** TData ** * extends* ` DeepValue ` \< ` TParentData ` , ` TName ` \>
66+ ` TFormOnMount ` * extends* ` undefined ` \| ` FormValidateOrFn ` \< ` TParentData ` \>
2367
24- • ** TOnMount ** * extends * ` undefined ` \| ` FieldValidateOrFn ` \< ` TParentData ` , ` TName ` , ` TData ` \>
68+ ### TFormOnChange
2569
26- • ** TOnChange ** * extends* ` undefined ` \| ` FieldValidateOrFn ` \< ` TParentData ` , ` TName ` , ` TData ` \>
70+ ` TFormOnChange ` * extends* ` undefined ` \| ` FormValidateOrFn ` \< ` TParentData ` \>
2771
28- • ** TOnChangeAsync ** * extends * ` undefined ` \| ` FieldAsyncValidateOrFn ` \< ` TParentData ` , ` TName ` , ` TData ` \>
72+ ### TFormOnChangeAsync
2973
30- • ** TOnBlur ** * extends* ` undefined ` \| ` FieldValidateOrFn ` \< ` TParentData ` , ` TName ` , ` TData ` \>
74+ ` TFormOnChangeAsync ` * extends* ` undefined ` \| ` FormAsyncValidateOrFn ` \< ` TParentData ` \>
3175
32- • ** TOnBlurAsync ** * extends * ` undefined ` \| ` FieldAsyncValidateOrFn ` \< ` TParentData ` , ` TName ` , ` TData ` \>
76+ ### TFormOnBlur
3377
34- • ** TOnSubmit ** * extends* ` undefined ` \| ` FieldValidateOrFn ` \< ` TParentData ` , ` TName ` , ` TData ` \>
78+ ` TFormOnBlur ` * extends* ` undefined ` \| ` FormValidateOrFn ` \< ` TParentData ` \>
3579
36- • ** TOnSubmitAsync ** * extends * ` undefined ` \| ` FieldAsyncValidateOrFn ` \< ` TParentData ` , ` TName ` , ` TData ` \>
80+ ### TFormOnBlurAsync
3781
38- • ** TOnDynamic ** * extends* ` undefined ` \| ` FieldValidateOrFn ` \< ` TParentData ` , ` TName ` , ` TData ` \>
82+ ` TFormOnBlurAsync ` * extends* ` undefined ` \| ` FormAsyncValidateOrFn ` \< ` TParentData ` \>
3983
40- • ** TOnDynamicAsync ** * extends * ` undefined ` \| ` FieldAsyncValidateOrFn ` \< ` TParentData ` , ` TName ` , ` TData ` \>
84+ ### TFormOnSubmit
4185
42- • ** TFormOnMount ** * extends* ` undefined ` \| ` FormValidateOrFn ` \< ` TParentData ` \>
86+ ` TFormOnSubmit ` * extends* ` undefined ` \| ` FormValidateOrFn ` \< ` TParentData ` \>
4387
44- • ** TFormOnChange ** * extends * ` undefined ` \| ` FormValidateOrFn ` \< ` TParentData ` \>
88+ ### TFormOnSubmitAsync
4589
46- • ** TFormOnChangeAsync ** * extends* ` undefined ` \| ` FormAsyncValidateOrFn ` \< ` TParentData ` \>
90+ ` TFormOnSubmitAsync ` * extends* ` undefined ` \| ` FormAsyncValidateOrFn ` \< ` TParentData ` \>
4791
48- • ** TFormOnBlur ** * extends * ` undefined ` \| ` FormValidateOrFn ` \< ` TParentData ` \>
92+ ### TFormOnDynamic
4993
50- • ** TFormOnBlurAsync ** * extends* ` undefined ` \| ` FormAsyncValidateOrFn ` \< ` TParentData ` \>
94+ ` TFormOnDynamic ` * extends* ` undefined ` \| ` FormValidateOrFn ` \< ` TParentData ` \>
5195
52- • ** TFormOnSubmit ** * extends * ` undefined ` \| ` FormValidateOrFn ` \< ` TParentData ` \>
96+ ### TFormOnDynamicAsync
5397
54- • ** TFormOnSubmitAsync ** * extends* ` undefined ` \| ` FormAsyncValidateOrFn ` \< ` TParentData ` \>
98+ ` TFormOnDynamicAsync ` * extends* ` undefined ` \| ` FormAsyncValidateOrFn ` \< ` TParentData ` \>
5599
56- • ** TFormOnDynamic ** * extends * ` undefined ` \| ` FormValidateOrFn ` \< ` TParentData ` \>
100+ ### TFormOnServer
57101
58- • ** TFormOnDynamicAsync ** * extends* ` undefined ` \| ` FormAsyncValidateOrFn ` \< ` TParentData ` \>
102+ ` TFormOnServer ` * extends* ` undefined ` \| ` FormAsyncValidateOrFn ` \< ` TParentData ` \>
59103
60- • ** TFormOnServer ** * extends * ` undefined ` \| ` FormAsyncValidateOrFn ` \< ` TParentData ` \>
104+ ### TSubmitMeta
61105
62- • ** TSubmitMeta**
106+ ` TSubmitMeta `
63107
64108## Implements
65109
66110- ` OnInit `
67111
68112## Constructors
69113
70- ### new TanStackField()
114+ ### Constructor
71115
72116``` ts
73- new TanStackField <TParentData , TName , TData , TOnMount , TOnChange , TOnChangeAsync , TOnBlur , TOnBlurAsync , TOnSubmit , TOnSubmitAsync , TOnDynamic , TOnDynamicAsync , TFormOnMount , TFormOnChange , TFormOnChangeAsync , TFormOnBlur , TFormOnBlurAsync , TFormOnSubmit , TFormOnSubmitAsync , TFormOnDynamic , TFormOnDynamicAsync , TFormOnServer , TSubmitMeta >(): TanStackField < TParentData , TName , TData , TOnMount , TOnChange , TOnChangeAsync , TOnBlur , TOnBlurAsync , TOnSubmit , TOnSubmitAsync , TOnDynamic , TOnDynamicAsync , TFormOnMount , TFormOnChange , TFormOnChangeAsync , TFormOnBlur , TFormOnBlurAsync , TFormOnSubmit , TFormOnSubmitAsync , TFormOnDynamic , TFormOnDynamicAsync , TFormOnServer , TSubmitMeta >
117+ new TanStackField <TParentData , TName , TData , TOnMount , TOnChange , TOnChangeAsync , TOnBlur , TOnBlurAsync , TOnSubmit , TOnSubmitAsync , TOnDynamic , TOnDynamicAsync , TFormOnMount , TFormOnChange , TFormOnChangeAsync , TFormOnBlur , TFormOnBlurAsync , TFormOnSubmit , TFormOnSubmitAsync , TFormOnDynamic , TFormOnDynamicAsync , TFormOnServer , TSubmitMeta >(): TanStackField < TParentData , TName , TData , TOnMount , TOnChange , TOnChangeAsync , TOnBlur , TOnBlurAsync , TOnSubmit , TOnSubmitAsync , TOnDynamic , TOnDynamicAsync , TFormOnMount , TFormOnChange , TFormOnChangeAsync , TFormOnBlur , TFormOnBlurAsync , TFormOnSubmit , TFormOnSubmitAsync , TFormOnDynamic , TFormOnDynamicAsync , TFormOnServer , TSubmitMeta > ;
74118```
75119
76120Defined in: [ tanstack-field.ts:224] ( https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L224 )
77121
78122#### Returns
79123
80- [ ` TanStackField ` ] ( ../tanstackfield.md ) \< ` TParentData ` , ` TName ` , ` TData ` , ` TOnMount ` , ` TOnChange ` , ` TOnChangeAsync ` , ` TOnBlur ` , ` TOnBlurAsync ` , ` TOnSubmit ` , ` TOnSubmitAsync ` , ` TOnDynamic ` , ` TOnDynamicAsync ` , ` TFormOnMount ` , ` TFormOnChange ` , ` TFormOnChangeAsync ` , ` TFormOnBlur ` , ` TFormOnBlurAsync ` , ` TFormOnSubmit ` , ` TFormOnSubmitAsync ` , ` TFormOnDynamic ` , ` TFormOnDynamicAsync ` , ` TFormOnServer ` , ` TSubmitMeta ` \>
124+ ` TanStackField ` \< ` TParentData ` , ` TName ` , ` TData ` , ` TOnMount ` , ` TOnChange ` , ` TOnChangeAsync ` , ` TOnBlur ` , ` TOnBlurAsync ` , ` TOnSubmit ` , ` TOnSubmitAsync ` , ` TOnDynamic ` , ` TOnDynamicAsync ` , ` TFormOnMount ` , ` TFormOnChange ` , ` TFormOnChangeAsync ` , ` TFormOnBlur ` , ` TFormOnBlurAsync ` , ` TFormOnSubmit ` , ` TFormOnSubmitAsync ` , ` TFormOnDynamic ` , ` TFormOnDynamicAsync ` , ` TFormOnServer ` , ` TSubmitMeta ` \>
81125
82126## Properties
83127
@@ -125,8 +169,8 @@ Defined in: [tanstack-field.ts:238](https://github.com/TanStack/form/blob/main/p
125169
126170``` ts
127171defaultMeta : InputSignal <
128- | undefined
129- | Partial < FieldMeta < TParentData , TName , TData , TOnMount , TOnChange , TOnChangeAsync , TOnBlur , TOnBlurAsync , TOnSubmit , TOnSubmitAsync , TOnDynamic , TOnDynamicAsync , TFormOnMount , TFormOnChange , TFormOnChangeAsync , TFormOnBlur , TFormOnBlurAsync , TFormOnSubmit , TFormOnSubmitAsync , TFormOnDynamic , TFormOnDynamicAsync >> > ;
172+ | Partial < FieldMeta < TParentData , TName , TData , TOnMount , TOnChange , TOnChangeAsync , TOnBlur , TOnBlurAsync , TOnSubmit , TOnSubmitAsync , TOnDynamic , TOnDynamicAsync , TFormOnMount , TFormOnChange , TFormOnChangeAsync , TFormOnBlur , TFormOnBlurAsync , TFormOnSubmit , TFormOnSubmitAsync , TFormOnDynamic , TFormOnDynamicAsync >>
173+ | undefined > ;
130174```
131175
132176Defined in: [ tanstack-field.ts:118] ( https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L118 )
@@ -136,7 +180,7 @@ Defined in: [tanstack-field.ts:118](https://github.com/TanStack/form/blob/main/p
136180### defaultValue
137181
138182``` ts
139- defaultValue : InputSignal < undefined | NoInfer < TData >> ;
183+ defaultValue : InputSignal < NoInfer < TData > | undefined > ;
140184```
141185
142186Defined in: [ tanstack-field.ts:72] ( https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L72 )
@@ -146,7 +190,7 @@ Defined in: [tanstack-field.ts:72](https://github.com/TanStack/form/blob/main/pa
146190### disableErrorFlat
147191
148192``` ts
149- disableErrorFlat : InputSignal < undefined | boolean > ;
193+ disableErrorFlat : InputSignal < boolean | undefined > ;
150194```
151195
152196Defined in: [ tanstack-field.ts:149] ( https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L149 )
@@ -167,8 +211,8 @@ Defined in: [tanstack-field.ts:222](https://github.com/TanStack/form/blob/main/p
167211
168212``` ts
169213listeners : InputSignal <
170- | undefined
171- | NoInfer < FieldListeners < TParentData , TName , TData >> > ;
214+ | NoInfer < FieldListeners < TParentData , TName , TData >>
215+ | undefined > ;
172216```
173217
174218Defined in: [ tanstack-field.ts:117] ( https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L117 )
@@ -178,7 +222,7 @@ Defined in: [tanstack-field.ts:117](https://github.com/TanStack/form/blob/main/p
178222### mode
179223
180224``` ts
181- mode : InputSignal < undefined | " value" | " array" > ;
225+ mode : InputSignal < " value" | " array" | undefined > ;
182226```
183227
184228Defined in: [ tanstack-field.ts:147] ( https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L147 )
@@ -219,8 +263,8 @@ Defined in: [tanstack-field.ts:79](https://github.com/TanStack/form/blob/main/pa
219263
220264``` ts
221265validators : InputSignal <
222- | undefined
223- | NoInfer < FieldValidators < TParentData , TName , TData , TOnMount , TOnChange , TOnChangeAsync , TOnBlur , TOnBlurAsync , TOnSubmit , TOnSubmitAsync , TOnDynamic , TOnDynamicAsync >> > ;
266+ | NoInfer < FieldValidators < TParentData , TName , TData , TOnMount , TOnChange , TOnChangeAsync , TOnBlur , TOnBlurAsync , TOnSubmit , TOnSubmitAsync , TOnDynamic , TOnDynamicAsync >>
267+ | undefined > ;
224268```
225269
226270Defined in: [ tanstack-field.ts:97] ( https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L97 )
@@ -232,7 +276,7 @@ Defined in: [tanstack-field.ts:97](https://github.com/TanStack/form/blob/main/pa
232276#### Get Signature
233277
234278``` ts
235- get api (): FieldApi < TParentData , TName , TData , TOnMount , TOnChange , TOnChangeAsync , TOnBlur , TOnBlurAsync , TOnSubmit , TOnSubmitAsync , TOnDynamic , TOnDynamicAsync , TFormOnMount , TFormOnChange , TFormOnChangeAsync , TFormOnBlur , TFormOnBlurAsync , TFormOnSubmit , TFormOnSubmitAsync , TFormOnDynamic , TFormOnDynamicAsync , TFormOnServer , TSubmitMeta >
279+ get api (): FieldApi < TParentData , TName , TData , TOnMount , TOnChange , TOnChangeAsync , TOnBlur , TOnBlurAsync , TOnSubmit , TOnSubmitAsync , TOnDynamic , TOnDynamicAsync , TFormOnMount , TFormOnChange , TFormOnChangeAsync , TFormOnBlur , TFormOnBlurAsync , TFormOnSubmit , TFormOnSubmitAsync , TFormOnDynamic , TFormOnDynamicAsync , TFormOnServer , TSubmitMeta > ;
236280```
237281
238282Defined in: [ tanstack-field.ts:155] ( https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L155 )
@@ -246,7 +290,7 @@ Defined in: [tanstack-field.ts:155](https://github.com/TanStack/form/blob/main/p
246290### ngOnInit()
247291
248292``` ts
249- ngOnInit (): void
293+ ngOnInit (): void ;
250294```
251295
252296Defined in: [ tanstack-field.ts:240] ( https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L240 )
0 commit comments