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

TanStackFormGroup.md

114 lines2.7 KB

Defined in: form-group.ts:25

Type Parameters

TFormData

TFormData

TGroupName

TGroupName extends DeepKeys<TFormData>

TGroupValue

TGroupValue extends DeepValue<TFormData, TGroupName>

TGroupValidators

TGroupValidators extends FormGroupValidators<TGroupValue>

TFormValidators

TFormValidators extends FormValidators<TFormData>

TSubmitReturn

TSubmitReturn

Constructors

Constructor

new TanStackFormGroup<TFormData, TGroupName, TGroupValue, TGroupValidators, TFormValidators, TSubmitReturn>(): TanStackFormGroup<TFormData, TGroupName, TGroupValue, TGroupValidators, TFormValidators, TSubmitReturn>;

Defined in: form-group.ts:84

Returns

TanStackFormGroup<TFormData, TGroupName, TGroupValue, TGroupValidators, TFormValidators, TSubmitReturn>

Properties

name

name: InputSignal<TGroupName>;

Defined in: form-group.ts:35


onSubmit

onSubmit: InputSignal<
  | FormGroupSubmitFn<TFormData, TGroupName, TGroupValue, TGroupValidators, ToFormErrorTypes<TFormValidators, TSubmitReturn>>
| undefined>;

Defined in: form-group.ts:37


onSubmitInvalid

onSubmitInvalid: InputSignal<((context) => void | Promise<void>) | undefined>;

Defined in: form-group.ts:47


tanstackFormGroup

tanstackFormGroup: InputSignal<InternalFormApi<TFormData, TFormValidators, TSubmitReturn>>;

Defined in: form-group.ts:33


validators

validators: InputSignal<NoInfer<TGroupValidators> | undefined>;

Defined in: form-group.ts:36

Accessors

api

Get Signature

get api(): InternalFormGroupApi<TFormData, TGroupName, TGroupValue, TGroupValidators, ToFormErrorTypes<TFormValidators, TSubmitReturn>>;

Defined in: form-group.ts:77

Returns

InternalFormGroupApi<TFormData, TGroupName, TGroupValue, TGroupValidators, ToFormErrorTypes<TFormValidators, TSubmitReturn>>