@@ -7,7 +7,7 @@ title: TanStackField
7
7
8
8
# Class: TanStackField\< TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnServer, TSubmitMeta\>
9
9
10
- Defined in: [ tanstack-field.directive.ts:32 ] ( https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L32 )
10
+ Defined in: [ tanstack-field.directive.ts:31 ] ( https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L31 )
11
11
12
12
## Type Parameters
13
13
@@ -76,7 +76,7 @@ new TanStackField<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync
76
76
api : FieldApi < TParentData , TName , TData , TOnMount , TOnChange , TOnChangeAsync , TOnBlur , TOnBlurAsync , TOnSubmit , TOnSubmitAsync , TFormOnMount , TFormOnChange , TFormOnChangeAsync , TFormOnBlur , TFormOnBlurAsync , TFormOnSubmit , TFormOnSubmitAsync , TFormOnServer , TSubmitMeta > ;
77
77
```
78
78
79
- Defined in: [ tanstack-field.directive.ts:133 ] ( https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L133 )
79
+ Defined in: [ tanstack-field.directive.ts:129 ] ( https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L129 )
80
80
81
81
***
82
82
@@ -86,7 +86,7 @@ Defined in: [tanstack-field.directive.ts:133](https://github.com/TanStack/form/b
86
86
optional asyncAlways : boolean ;
87
87
```
88
88
89
- Defined in: [ tanstack-field.directive.ts:82 ] ( https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L82 )
89
+ Defined in: [ tanstack-field.directive.ts:78 ] ( https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L78 )
90
90
91
91
If ` true ` , always run async validation, even if there are errors emitted during synchronous validation.
92
92
@@ -104,7 +104,7 @@ FieldOptions.asyncAlways
104
104
optional asyncDebounceMs : number ;
105
105
```
106
106
107
- Defined in: [ tanstack-field.directive.ts:81 ] ( https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L81 )
107
+ Defined in: [ tanstack-field.directive.ts:77 ] ( https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L77 )
108
108
109
109
The default time to debounce async validation if there is not a more specific debounce time passed.
110
110
@@ -122,7 +122,7 @@ FieldOptions.asyncDebounceMs
122
122
optional defaultMeta : Partial < FieldMeta < TParentData , TName , TData , TOnMount , TOnChange , TOnChangeAsync , TOnBlur , TOnBlurAsync , TOnSubmit , TOnSubmitAsync , TFormOnMount , TFormOnChange , TFormOnChangeAsync , TFormOnBlur , TFormOnBlurAsync , TFormOnSubmit , TFormOnSubmitAsync >> ;
123
123
```
124
124
125
- Defined in: [ tanstack-field.directive.ts:110 ] ( https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L110 )
125
+ Defined in: [ tanstack-field.directive.ts:106 ] ( https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L106 )
126
126
127
127
An optional object with default metadata for the field.
128
128
@@ -140,7 +140,7 @@ FieldOptions.defaultMeta
140
140
optional defaultValue : NoInfer < TData > ;
141
141
```
142
142
143
- Defined in: [ tanstack-field.directive.ts:80 ] ( https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L80 )
143
+ Defined in: [ tanstack-field.directive.ts:76 ] ( https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L76 )
144
144
145
145
An optional default value for the field.
146
146
@@ -158,7 +158,7 @@ FieldOptions.defaultValue
158
158
optional disableErrorFlat : boolean ;
159
159
```
160
160
161
- Defined in: [ tanstack-field.directive.ts:131 ] ( https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L131 )
161
+ Defined in: [ tanstack-field.directive.ts:127 ] ( https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L127 )
162
162
163
163
Disable the ` flat(1) ` operation on ` field.errors ` . This is useful if you want to keep the error structure as is. Not suggested for most use-cases.
164
164
@@ -176,7 +176,7 @@ FieldOptions.disableErrorFlat
176
176
optional listeners : NoInfer < FieldListeners < TParentData , TName , TData >> ;
177
177
```
178
178
179
- Defined in: [ tanstack-field.directive.ts:109 ] ( https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L109 )
179
+ Defined in: [ tanstack-field.directive.ts:105 ] ( https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L105 )
180
180
181
181
A list of listeners which attach to the corresponding events
182
182
@@ -194,7 +194,7 @@ FieldOptions.listeners
194
194
name : TName ;
195
195
```
196
196
197
- Defined in: [ tanstack-field.directive.ts:76 ] ( https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L76 )
197
+ Defined in: [ tanstack-field.directive.ts:75 ] ( https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L75 )
198
198
199
199
The field name. The type will be ` DeepKeys<TParentData> ` to ensure your name is a deep key of the parent dataset.
200
200
@@ -212,7 +212,7 @@ FieldOptions.name
212
212
tanstackField : FormApi < TParentData , TFormOnMount , TFormOnChange , TFormOnChangeAsync , TFormOnBlur , TFormOnBlurAsync , TFormOnSubmit , TFormOnSubmitAsync , TFormOnServer , TSubmitMeta > ;
213
213
```
214
214
215
- Defined in: [ tanstack-field.directive.ts:83 ] ( https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L83 )
215
+ Defined in: [ tanstack-field.directive.ts:79 ] ( https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L79 )
216
216
217
217
***
218
218
@@ -222,7 +222,7 @@ Defined in: [tanstack-field.directive.ts:83](https://github.com/TanStack/form/bl
222
222
optional unmount : () => void ;
223
223
```
224
224
225
- Defined in: [ tanstack-field.directive.ts:189 ] ( https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L189 )
225
+ Defined in: [ tanstack-field.directive.ts:185 ] ( https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L185 )
226
226
227
227
#### Returns
228
228
@@ -236,7 +236,7 @@ Defined in: [tanstack-field.directive.ts:189](https://github.com/TanStack/form/b
236
236
optional validators : NoInfer < FieldValidators < TParentData , TName , TData , TOnMount , TOnChange , TOnChangeAsync , TOnBlur , TOnBlurAsync , TOnSubmit , TOnSubmitAsync >> ;
237
237
```
238
238
239
- Defined in: [ tanstack-field.directive.ts:95 ] ( https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L95 )
239
+ Defined in: [ tanstack-field.directive.ts:91 ] ( https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L91 )
240
240
241
241
A list of validators to pass to the field
242
242
@@ -254,7 +254,7 @@ FieldOptions.validators
254
254
ngOnChanges (): void
255
255
```
256
256
257
- Defined in: [ tanstack-field.directive.ts:201 ] ( https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L201 )
257
+ Defined in: [ tanstack-field.directive.ts:197 ] ( https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L197 )
258
258
259
259
A callback method that is invoked immediately after the
260
260
default change detector has checked data-bound properties
@@ -279,7 +279,7 @@ OnChanges.ngOnChanges
279
279
ngOnDestroy (): void
280
280
```
281
281
282
- Defined in: [ tanstack-field.directive.ts:197 ] ( https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L197 )
282
+ Defined in: [ tanstack-field.directive.ts:193 ] ( https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L193 )
283
283
284
284
A callback method that performs custom clean-up, invoked immediately
285
285
before a directive, pipe, or service instance is destroyed.
@@ -302,7 +302,7 @@ OnDestroy.ngOnDestroy
302
302
ngOnInit (): void
303
303
```
304
304
305
- Defined in: [ tanstack-field.directive.ts:191 ] ( https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L191 )
305
+ Defined in: [ tanstack-field.directive.ts:187 ] ( https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L187 )
306
306
307
307
A callback method that is invoked immediately after the
308
308
default change detector has checked the directive's
0 commit comments