Form Docs
Recommended Types
Form Composition API Reference
FormApi Reference
- form.setFieldValue()
- form.getFieldValue()
- form.resetField()
- form.swapFieldValues()
- form.moveFieldValue()
- form.pushFieldValue()
- form.insertFieldValue()
- form.clearFieldValues()
- form.removeFieldValue()
- form.filterFieldValues()
- form.handleSubmit()
- form.reset()
- FormApi
- FormOptions
- FormState
- FormResetOptions
- FormSubmitContext
- FormSubmitInvalidContext
Form Listener API Reference
Field Listener API Reference
AI/LLM: This documentation page is available in plain markdown format at/form/alpha/docs/reference/interfaces/FormGroupSubmitContext.md
FormGroupSubmitContext
Defined in: FormGroupApi/FormGroupApi.public.ts:27
Context passed to a form group's onSubmit after group validation succeeds.
Example#
ts
{
// ...
onSubmit: async ({ value }) => {
await saveGuestDetails(value)
},
}Type Parameters#
TFormData#
TFormData
TGroupName#
TGroupName
TGroupValue#
TGroupValue
TOutputs#
TOutputs
TGroupError#
TGroupError extends ScopedErrorTypes
TFormError#
TFormError extends ScopedErrorTypes
Properties#
formApi#
ts
formApi: FormApi<TFormData, TFormError>;Defined in: FormGroupApi/FormGroupApi.public.ts:38
The parent form API handling this submission.
groupApi#
ts
groupApi: FormGroupApi<TFormData, TGroupName, TGroupValue, TGroupError, TFormError>;Defined in: FormGroupApi/FormGroupApi.public.ts:40
The group API handling this submission.
validatorOutputs#
ts
validatorOutputs: TOutputs;Defined in: FormGroupApi/FormGroupApi.public.ts:63
Schema outputs and createOutput payloads from this group submission, ordered by validator index. Skipped validators and successful returns without an output contribute undefined.
Example#
ts
{
// ...
onSubmit: async ({ validatorOutputs }) => {
const validatedGuestDetails = validatorOutputs[0]
setStep(step => step + 1)
},
}value#
ts
value: TGroupValue;Defined in: FormGroupApi/FormGroupApi.public.ts:36
The group values for this submission.