Interface: FormGroupApi<TFormData, TGroupName, TGroupValue, TGroupErrorTypes, TFormErrorTypes>#

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

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:190

form#

readonly form: FormApi<TFormData, TFormErrorTypes>;

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

handleSubmit#

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

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

Returns#

Promise<FormGroupValidateResult<TGroupValue>[]>

name#

readonly name: TGroupName;

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

reset#

reset: () => void;

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

Returns#

void

state#

readonly state: FormGroupState<TGroupValue, TGroupErrorTypes>;

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

validate#

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

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

Parameters#

signal#

| "submit" | ConfigurableValidationTrigger

Returns#

Promise<FormGroupValidateResult<TGroupValue>[]>

value#

readonly value: TGroupValue;

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