0
Fork 0
mirror of https://github.com/TanStack/form.git synced 2026-11-18 07:36:42 +00:00
form/docs/framework/angular/reference/classes/TanStackFormGroup.md
2026-09-22 02:24:35 +00:00

11 KiB

id title
TanStackFormGroup TanStackFormGroup

Defined in: angular-form/src/tanstack-form-group.ts:34

Type Parameters

TParentData

TParentData

TName

TName extends DeepKeys<TParentData>

TData

TData extends DeepValue<TParentData, TName>

TOnMount

TOnMount extends undefined | FormGroupValidateOrFn<TParentData, TName, TData>

TOnChange

TOnChange extends undefined | FormGroupValidateOrFn<TParentData, TName, TData>

TOnChangeAsync

TOnChangeAsync extends | undefined | FormGroupAsyncValidateOrFn<TParentData, TName, TData>

TOnBlur

TOnBlur extends undefined | FormGroupValidateOrFn<TParentData, TName, TData>

TOnBlurAsync

TOnBlurAsync extends | undefined | FormGroupAsyncValidateOrFn<TParentData, TName, TData>

TOnSubmit

TOnSubmit extends undefined | FormGroupValidateOrFn<TParentData, TName, TData>

TOnSubmitAsync

TOnSubmitAsync extends | undefined | FormGroupAsyncValidateOrFn<TParentData, TName, TData>

TOnDynamic

TOnDynamic extends undefined | FormGroupValidateOrFn<TParentData, TName, TData>

TOnDynamicAsync

TOnDynamicAsync extends | undefined | FormGroupAsyncValidateOrFn<TParentData, TName, TData>

TSubmitMeta

TSubmitMeta

TFormOnMount

TFormOnMount extends undefined | FormValidateOrFn<TParentData>

TFormOnChange

TFormOnChange extends undefined | FormValidateOrFn<TParentData>

TFormOnChangeAsync

TFormOnChangeAsync extends undefined | FormAsyncValidateOrFn<TParentData>

TFormOnBlur

TFormOnBlur extends undefined | FormValidateOrFn<TParentData>

TFormOnBlurAsync

TFormOnBlurAsync extends undefined | FormAsyncValidateOrFn<TParentData>

TFormOnSubmit

TFormOnSubmit extends undefined | FormValidateOrFn<TParentData>

TFormOnSubmitAsync

TFormOnSubmitAsync extends undefined | FormAsyncValidateOrFn<TParentData>

TFormOnDynamic

TFormOnDynamic extends undefined | FormValidateOrFn<TParentData>

TFormOnDynamicAsync

TFormOnDynamicAsync extends undefined | FormAsyncValidateOrFn<TParentData>

TFormOnServer

TFormOnServer extends undefined | FormAsyncValidateOrFn<TParentData>

TParentSubmitMeta

TParentSubmitMeta

Implements

  • OnInit

Constructors

Constructor

new TanStackFormGroup<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TSubmitMeta, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnDynamic, TFormOnDynamicAsync, TFormOnServer, TParentSubmitMeta>(): TanStackFormGroup<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TSubmitMeta, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnDynamic, TFormOnDynamicAsync, TFormOnServer, TParentSubmitMeta>;

Defined in: angular-form/src/tanstack-form-group.ts:303

Returns

TanStackFormGroup<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TSubmitMeta, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnDynamic, TFormOnDynamicAsync, TFormOnServer, TParentSubmitMeta>

Properties

_api

_api: Signal<FormGroupApi<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TSubmitMeta, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnDynamic, TFormOnDynamicAsync, TFormOnServer, TParentSubmitMeta>>;

Defined in: angular-form/src/tanstack-form-group.ts:224


asyncAlways

asyncAlways: InputSignalWithTransform<boolean, unknown>;

Defined in: angular-form/src/tanstack-form-group.ts:79


asyncDebounceMs

asyncDebounceMs: InputSignalWithTransform<number, unknown>;

Defined in: angular-form/src/tanstack-form-group.ts:76


canSubmitWhenInvalid

canSubmitWhenInvalid: InputSignalWithTransform<boolean, unknown>;

Defined in: angular-form/src/tanstack-form-group.ts:82


cd

cd: ChangeDetectorRef;

Defined in: angular-form/src/tanstack-form-group.ts:317


defaultMeta

defaultMeta: InputSignal<
  | Partial<FieldLikeMeta<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnDynamic, TFormOnDynamicAsync>>
| undefined>;

Defined in: angular-form/src/tanstack-form-group.ts:125


defaultState

defaultState: InputSignal<Partial<FormGroupState> | undefined>;

Defined in: angular-form/src/tanstack-form-group.ts:154


defaultValue

defaultValue: InputSignal<NoInfer<TData> | undefined>;

Defined in: angular-form/src/tanstack-form-group.ts:75


injector

injector: Injector;

Defined in: angular-form/src/tanstack-form-group.ts:301


listeners

listeners: InputSignal<
  | NoInfer<FormGroupListeners<TParentData, TName, TData>>
| undefined>;

Defined in: angular-form/src/tanstack-form-group.ts:123


mode

mode: InputSignal<"value" | "array" | undefined>;

Defined in: angular-form/src/tanstack-form-group.ts:222


name

name: InputSignal<TName>;

Defined in: angular-form/src/tanstack-form-group.ts:74


onGroupSubmit

onGroupSubmit: InputSignal<NoInfer<(props) => any | undefined> | undefined>;

Defined in: angular-form/src/tanstack-form-group.ts:158


onGroupSubmitInvalid

onGroupSubmitInvalid: InputSignal<NoInfer<(props) => void | undefined> | undefined>;

Defined in: angular-form/src/tanstack-form-group.ts:190


onSubmitMeta

onSubmitMeta: InputSignal<NoInfer<TSubmitMeta> | undefined>;

Defined in: angular-form/src/tanstack-form-group.ts:156


options

options: Signal<FormGroupApiOptions<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TSubmitMeta, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnDynamic, TFormOnDynamicAsync, TFormOnServer, TParentSubmitMeta>>;

Defined in: angular-form/src/tanstack-form-group.ts:257


tanstackFormGroup

tanstackFormGroup: InputSignal<FormApi<TParentData, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnDynamic, TFormOnDynamicAsync, TFormOnServer, TParentSubmitMeta>>;

Defined in: angular-form/src/tanstack-form-group.ts:85


validators

validators: InputSignal<
  | NoInfer<FormGroupValidators<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync>>
| undefined>;

Defined in: angular-form/src/tanstack-form-group.ts:103

Accessors

api

Get Signature

get api(): FormGroupApi<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TSubmitMeta, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnDynamic, TFormOnDynamicAsync, TFormOnServer, TParentSubmitMeta>;

Defined in: angular-form/src/tanstack-form-group.ts:228

Returns

FormGroupApi<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TSubmitMeta, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnDynamic, TFormOnDynamicAsync, TFormOnServer, TParentSubmitMeta>

Methods

ngOnInit()

ngOnInit(): void;

Defined in: angular-form/src/tanstack-form-group.ts:319

A callback method that is invoked immediately after the default change detector has checked the directive's data-bound properties for the first time, and before any of the view or content children have been checked. It is invoked only once when the directive is instantiated.

Returns

void

Implementation of

OnInit.ngOnInit