Interface: FormSubmitContext<TFormData, TSchemaOutputs, TFormErrorTypes>#

Defined in: FormApi/FormApi.public.ts:101

Context passed to onSubmit after submission validation succeeds.

Example#

{
  // ...
  onSubmit: async ({ value, createValidationError }) => {
    const result = await saveUser(value)

    if (!result.ok) {
      return createValidationError(result.error)
    }
  },
}

Type Parameters#

TFormData#

TFormData

Library-managed. Do not specify explicitly.

TSchemaOutputs#

TSchemaOutputs

Library-managed. Do not specify explicitly.

TFormErrorTypes#

TFormErrorTypes extends FormErrorTypes

Library-managed. Do not specify explicitly.

Properties#

createValidationError#

createValidationError: CreateValidationErrorFn<TFormData>;

Defined in: FormApi/FormApi.public.ts:149

Creates a validation error that can be returned from onSubmit.

Return the created error from onSubmit to add its form- and field-level errors to validation state.

Example#

{
  // ...
  onSubmit: async ({ value, createValidationError }) => {
    const result = await saveUser(value)

    if (result.status === 409) {
      return createValidationError({
        form: 'A user with this email already exists',
        fields: {},
      })
    }
  },
}

formApi#

formApi: FormApi<TFormData, TFormErrorTypes>;

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

The form API handling this submission.

parseIssues#

parseIssues: ParseSubmitIssuesFn<TFormData>;

Defined in: FormApi/FormApi.public.ts:170

Parses Standard Schema issues into an error returnable from onSubmit.

Issue paths are mapped to fields in the submitted value. Return the parsed error from onSubmit to add those errors to validation state.

Example#

{
  // ...
  onSubmit: async ({ value, parseIssues }) => {
    const result = zodSchema.safeParse(value)

    if (!result.success) {
      return parseIssues(result.error.issues)
    }
  },
}

schemaOutputs#

schemaOutputs: TSchemaOutputs;

Defined in: FormApi/FormApi.public.ts:125

The submit outputs produced by the form's schema validators, ordered by validator index.

Example#

{
  // ...
  onSubmit: async ({ schemaOutputs }) => {
    const validatedUser = schemaOutputs[0]
    await saveUser(validatedUser)
  },
}

value#

value: TFormData;

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

The form values for this submission.