|
| 1 | +--- |
| 2 | +id: TanStackAppField |
| 3 | +title: TanStackAppField |
| 4 | +--- |
| 5 | + |
| 6 | +<!-- DO NOT EDIT: this page is autogenerated from the type comments --> |
| 7 | + |
| 8 | +# Class: TanStackAppField\<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnServer, TSubmitMeta\> |
| 9 | + |
| 10 | +Defined in: [app-field.ts:20](https://github.com/TanStack/form/blob/main/packages/angular-form/src/app-field.ts#L20) |
| 11 | + |
| 12 | +## Extends |
| 13 | + |
| 14 | +- [`TanStackField`](../tanstackfield.md)\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnServer`, `TSubmitMeta`\> |
| 15 | + |
| 16 | +## Type Parameters |
| 17 | + |
| 18 | +• **TParentData** |
| 19 | + |
| 20 | +• **TName** *extends* `DeepKeys`\<`TParentData`\> |
| 21 | + |
| 22 | +• **TData** *extends* `DeepValue`\<`TParentData`, `TName`\> |
| 23 | + |
| 24 | +• **TOnMount** *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\> |
| 25 | + |
| 26 | +• **TOnChange** *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\> |
| 27 | + |
| 28 | +• **TOnChangeAsync** *extends* `undefined` \| `FieldAsyncValidateOrFn`\<`TParentData`, `TName`, `TData`\> |
| 29 | + |
| 30 | +• **TOnBlur** *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\> |
| 31 | + |
| 32 | +• **TOnBlurAsync** *extends* `undefined` \| `FieldAsyncValidateOrFn`\<`TParentData`, `TName`, `TData`\> |
| 33 | + |
| 34 | +• **TOnSubmit** *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\> |
| 35 | + |
| 36 | +• **TOnSubmitAsync** *extends* `undefined` \| `FieldAsyncValidateOrFn`\<`TParentData`, `TName`, `TData`\> |
| 37 | + |
| 38 | +• **TFormOnMount** *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\> |
| 39 | + |
| 40 | +• **TFormOnChange** *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\> |
| 41 | + |
| 42 | +• **TFormOnChangeAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\> |
| 43 | + |
| 44 | +• **TFormOnBlur** *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\> |
| 45 | + |
| 46 | +• **TFormOnBlurAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\> |
| 47 | + |
| 48 | +• **TFormOnSubmit** *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\> |
| 49 | + |
| 50 | +• **TFormOnSubmitAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\> |
| 51 | + |
| 52 | +• **TFormOnServer** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\> |
| 53 | + |
| 54 | +• **TSubmitMeta** |
| 55 | + |
| 56 | +## Constructors |
| 57 | + |
| 58 | +### new TanStackAppField() |
| 59 | + |
| 60 | +```ts |
| 61 | +new TanStackAppField<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnServer, TSubmitMeta>(): TanStackAppField<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnServer, TSubmitMeta> |
| 62 | +``` |
| 63 | + |
| 64 | +Defined in: [app-field.ts:69](https://github.com/TanStack/form/blob/main/packages/angular-form/src/app-field.ts#L69) |
| 65 | + |
| 66 | +#### Returns |
| 67 | + |
| 68 | +[`TanStackAppField`](../tanstackappfield.md)\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnServer`, `TSubmitMeta`\> |
| 69 | + |
| 70 | +#### Overrides |
| 71 | + |
| 72 | +[`TanStackField`](../tanstackfield.md).[`constructor`](../TanStackField.md#constructors) |
| 73 | + |
| 74 | +## Properties |
| 75 | + |
| 76 | +### \_api |
| 77 | + |
| 78 | +```ts |
| 79 | +_api: Signal<FieldApi<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnServer, TSubmitMeta>>; |
| 80 | +``` |
| 81 | + |
| 82 | +Defined in: [tanstack-field.ts:137](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L137) |
| 83 | + |
| 84 | +#### Inherited from |
| 85 | + |
| 86 | +[`TanStackField`](../tanstackfield.md).[`_api`](../TanStackField.md#_api) |
| 87 | + |
| 88 | +*** |
| 89 | + |
| 90 | +### asyncAlways |
| 91 | + |
| 92 | +```ts |
| 93 | +asyncAlways: InputSignalWithTransform<boolean, unknown>; |
| 94 | +``` |
| 95 | + |
| 96 | +Defined in: [tanstack-field.ts:70](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L70) |
| 97 | + |
| 98 | +#### Inherited from |
| 99 | + |
| 100 | +[`TanStackField`](../tanstackfield.md).[`asyncAlways`](../TanStackField.md#asyncalways) |
| 101 | + |
| 102 | +*** |
| 103 | + |
| 104 | +### asyncDebounceMs |
| 105 | + |
| 106 | +```ts |
| 107 | +asyncDebounceMs: InputSignalWithTransform<number, unknown>; |
| 108 | +``` |
| 109 | + |
| 110 | +Defined in: [tanstack-field.ts:67](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L67) |
| 111 | + |
| 112 | +#### Inherited from |
| 113 | + |
| 114 | +[`TanStackField`](../tanstackfield.md).[`asyncDebounceMs`](../TanStackField.md#asyncdebouncems) |
| 115 | + |
| 116 | +*** |
| 117 | + |
| 118 | +### base |
| 119 | + |
| 120 | +```ts |
| 121 | +base: TanStackFieldInjectable<any>; |
| 122 | +``` |
| 123 | + |
| 124 | +Defined in: [app-field.ts:67](https://github.com/TanStack/form/blob/main/packages/angular-form/src/app-field.ts#L67) |
| 125 | + |
| 126 | +*** |
| 127 | + |
| 128 | +### cd |
| 129 | + |
| 130 | +```ts |
| 131 | +cd: ChangeDetectorRef; |
| 132 | +``` |
| 133 | + |
| 134 | +Defined in: [tanstack-field.ts:216](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L216) |
| 135 | + |
| 136 | +#### Inherited from |
| 137 | + |
| 138 | +[`TanStackField`](../tanstackfield.md).[`cd`](../TanStackField.md#cd) |
| 139 | + |
| 140 | +*** |
| 141 | + |
| 142 | +### defaultMeta |
| 143 | + |
| 144 | +```ts |
| 145 | +defaultMeta: InputSignal< |
| 146 | + | undefined |
| 147 | +| Partial<FieldMeta<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync>>>; |
| 148 | +``` |
| 149 | + |
| 150 | +Defined in: [tanstack-field.ts:108](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L108) |
| 151 | + |
| 152 | +#### Inherited from |
| 153 | + |
| 154 | +[`TanStackField`](../tanstackfield.md).[`defaultMeta`](../TanStackField.md#defaultmeta) |
| 155 | + |
| 156 | +*** |
| 157 | + |
| 158 | +### defaultValue |
| 159 | + |
| 160 | +```ts |
| 161 | +defaultValue: InputSignal<undefined | NoInfer<TData>>; |
| 162 | +``` |
| 163 | + |
| 164 | +Defined in: [tanstack-field.ts:66](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L66) |
| 165 | + |
| 166 | +#### Inherited from |
| 167 | + |
| 168 | +[`TanStackField`](../tanstackfield.md).[`defaultValue`](../TanStackField.md#defaultvalue) |
| 169 | + |
| 170 | +*** |
| 171 | + |
| 172 | +### disableErrorFlat |
| 173 | + |
| 174 | +```ts |
| 175 | +disableErrorFlat: InputSignal<undefined | boolean>; |
| 176 | +``` |
| 177 | + |
| 178 | +Defined in: [tanstack-field.ts:135](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L135) |
| 179 | + |
| 180 | +#### Inherited from |
| 181 | + |
| 182 | +[`TanStackField`](../tanstackfield.md).[`disableErrorFlat`](../TanStackField.md#disableerrorflat) |
| 183 | + |
| 184 | +*** |
| 185 | + |
| 186 | +### injector |
| 187 | + |
| 188 | +```ts |
| 189 | +injector: Injector; |
| 190 | +``` |
| 191 | + |
| 192 | +Defined in: [tanstack-field.ts:200](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L200) |
| 193 | + |
| 194 | +#### Inherited from |
| 195 | + |
| 196 | +[`TanStackField`](../tanstackfield.md).[`injector`](../TanStackField.md#injector) |
| 197 | + |
| 198 | +*** |
| 199 | + |
| 200 | +### listeners |
| 201 | + |
| 202 | +```ts |
| 203 | +listeners: InputSignal< |
| 204 | + | undefined |
| 205 | +| NoInfer<FieldListeners<TParentData, TName, TData>>>; |
| 206 | +``` |
| 207 | + |
| 208 | +Defined in: [tanstack-field.ts:107](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L107) |
| 209 | + |
| 210 | +#### Inherited from |
| 211 | + |
| 212 | +[`TanStackField`](../tanstackfield.md).[`listeners`](../TanStackField.md#listeners) |
| 213 | + |
| 214 | +*** |
| 215 | + |
| 216 | +### mode |
| 217 | + |
| 218 | +```ts |
| 219 | +mode: InputSignal<undefined | "value" | "array">; |
| 220 | +``` |
| 221 | + |
| 222 | +Defined in: [tanstack-field.ts:133](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L133) |
| 223 | + |
| 224 | +#### Inherited from |
| 225 | + |
| 226 | +[`TanStackField`](../tanstackfield.md).[`mode`](../TanStackField.md#mode) |
| 227 | + |
| 228 | +*** |
| 229 | + |
| 230 | +### name |
| 231 | + |
| 232 | +```ts |
| 233 | +name: InputSignal<TName>; |
| 234 | +``` |
| 235 | + |
| 236 | +Defined in: [tanstack-field.ts:65](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L65) |
| 237 | + |
| 238 | +#### Inherited from |
| 239 | + |
| 240 | +[`TanStackField`](../tanstackfield.md).[`name`](../TanStackField.md#name) |
| 241 | + |
| 242 | +*** |
| 243 | + |
| 244 | +### options |
| 245 | + |
| 246 | +```ts |
| 247 | +options: Signal<FieldApiOptions<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnServer, TSubmitMeta>>; |
| 248 | +``` |
| 249 | + |
| 250 | +Defined in: [tanstack-field.ts:165](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L165) |
| 251 | + |
| 252 | +#### Inherited from |
| 253 | + |
| 254 | +[`TanStackField`](../tanstackfield.md).[`options`](../TanStackField.md#options) |
| 255 | + |
| 256 | +*** |
| 257 | + |
| 258 | +### tanstackField |
| 259 | + |
| 260 | +```ts |
| 261 | +tanstackField: InputSignal<FormApi<TParentData, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnServer, TSubmitMeta>>; |
| 262 | +``` |
| 263 | + |
| 264 | +Defined in: [tanstack-field.ts:73](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L73) |
| 265 | + |
| 266 | +#### Inherited from |
| 267 | + |
| 268 | +[`TanStackField`](../tanstackfield.md).[`tanstackField`](../TanStackField.md#tanstackfield) |
| 269 | + |
| 270 | +*** |
| 271 | + |
| 272 | +### validators |
| 273 | + |
| 274 | +```ts |
| 275 | +validators: InputSignal< |
| 276 | + | undefined |
| 277 | +| NoInfer<FieldValidators<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync>>>; |
| 278 | +``` |
| 279 | + |
| 280 | +Defined in: [tanstack-field.ts:89](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L89) |
| 281 | + |
| 282 | +#### Inherited from |
| 283 | + |
| 284 | +[`TanStackField`](../tanstackfield.md).[`validators`](../TanStackField.md#validators) |
| 285 | + |
| 286 | +## Accessors |
| 287 | + |
| 288 | +### api |
| 289 | + |
| 290 | +#### Get Signature |
| 291 | + |
| 292 | +```ts |
| 293 | +get api(): FieldApi<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnServer, TSubmitMeta> |
| 294 | +``` |
| 295 | + |
| 296 | +Defined in: [tanstack-field.ts:141](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L141) |
| 297 | + |
| 298 | +##### Returns |
| 299 | + |
| 300 | +`FieldApi`\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnServer`, `TSubmitMeta`\> |
| 301 | + |
| 302 | +#### Inherited from |
| 303 | + |
| 304 | +[`TanStackField`](../tanstackfield.md).[`api`](../TanStackField.md#api) |
| 305 | + |
| 306 | +## Methods |
| 307 | + |
| 308 | +### ngOnInit() |
| 309 | + |
| 310 | +```ts |
| 311 | +ngOnInit(): void |
| 312 | +``` |
| 313 | + |
| 314 | +Defined in: [tanstack-field.ts:218](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L218) |
| 315 | + |
| 316 | +A callback method that is invoked immediately after the |
| 317 | +default change detector has checked the directive's |
| 318 | +data-bound properties for the first time, |
| 319 | +and before any of the view or content children have been checked. |
| 320 | +It is invoked only once when the directive is instantiated. |
| 321 | + |
| 322 | +#### Returns |
| 323 | + |
| 324 | +`void` |
| 325 | + |
| 326 | +#### Inherited from |
| 327 | + |
| 328 | +[`TanStackField`](../tanstackfield.md).[`ngOnInit`](../TanStackField.md#ngoninit) |
0 commit comments