Interface: FormGroupOptions<TFormData, TGroupName, TGroupValue, TGroupValidators, TFormErrorTypes>#

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

Type Parameters#

TFormData#

TFormData

TGroupName#

TGroupName

TGroupValue#

TGroupValue

TGroupValidators#

TGroupValidators extends FormGroupValidators<TGroupValue>

TFormErrorTypes#

TFormErrorTypes extends FormErrorTypes

Properties#

form#

form: FormApi<TFormData, TFormErrorTypes>;

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

name#

name: TGroupName;

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

onSubmit?#

optional onSubmit?: (context) => void | Promise<void>;

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

Called after group submission validation succeeds. The callback is awaited before submission finishes.

Parameters#

context#

FormGroupSubmitContext<TFormData, TGroupName, TGroupValue, ToFormGroupSchemaOutputs<NoInfer<TGroupValidators>>, ToFormGroupErrorTypes<NoInfer<TGroupValidators>>, TFormErrorTypes>

Returns#

void | Promise<void>

Example#

{
  // ...
  onSubmit: () => {
    setStep(step => step + 1)
  },
}

onSubmitInvalid?#

optional onSubmitInvalid?: (context) => void | Promise<void>;

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

Called when group validation fails or validation or submission throws. The callback is awaited before submission finishes.

Parameters#

context#

FormGroupSubmitInvalidContext<TFormData, TGroupName, TGroupValue, ToFormGroupErrorTypes<NoInfer<TGroupValidators>>, TFormErrorTypes>

Returns#

void | Promise<void>

Example#

{
  // ...
  onSubmitInvalid: ({ groupApi }) => {
    document
      .querySelector<HTMLElement>('[aria-invalid="true"]')
      ?.focus()
  },
}

validators?#

optional validators?: TGroupValidators;

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