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

FormGroupApi.md

127 lines2.8 KB

Defined in: FormGroupApi/FormGroupApi.public.ts:195

Type Parameters

TFormData

TFormData

TGroupName

TGroupName

TGroupValue

TGroupValue

TGroupErrorTypes

TGroupErrorTypes extends FormErrorTypes

TFormErrorTypes

TFormErrorTypes extends FormErrorTypes

Properties

atom

atom: ReadonlyAtom<FormGroupState<TGroupValue, TGroupErrorTypes>>;

Defined in: FormGroupApi/FormGroupApi.public.ts:205


form

readonly form: FormApi<TFormData, TFormErrorTypes>;

Defined in: FormGroupApi/FormGroupApi.public.ts:202


handleSubmit

handleSubmit: () => Promise<FormGroupValidateResult<TGroupValue>[]>;

Defined in: FormGroupApi/FormGroupApi.public.ts:211

Returns

Promise<FormGroupValidateResult<TGroupValue>[]>


name

readonly name: TGroupName;

Defined in: FormGroupApi/FormGroupApi.public.ts:203


reset

reset: () => void;

Defined in: FormGroupApi/FormGroupApi.public.ts:212

Returns

void


state

readonly state: FormGroupState<TGroupValue, TGroupErrorTypes>;

Defined in: FormGroupApi/FormGroupApi.public.ts:206


validate

validate: (signal) => Promise<FormGroupValidateResult<TGroupValue>[]>;

Defined in: FormGroupApi/FormGroupApi.public.ts:208

Parameters

signal

| "submit" | ConfigurableValidationTrigger

Returns

Promise<FormGroupValidateResult<TGroupValue>[]>


value

readonly value: TGroupValue;

Defined in: FormGroupApi/FormGroupApi.public.ts:207