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

FormSubmitContext.md

166 lines3.3 KB

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

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.

TOutputs

TOutputs

Library-managed. Do not specify explicitly.

TFormErrorTypes

TFormErrorTypes extends FormErrorTypes

Library-managed. Do not specify explicitly.

Properties

createErrorMap

createErrorMap: CreateSubmitErrorMapFn<TFormData>;

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


createValidationError

createValidationError: CreateValidationErrorFn<TFormData>;

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

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

The form API handling this submission.


parseIssues

parseIssues: ParseSubmitIssuesFn<TFormData>;

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

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)
    }
  },
}

validatorOutputs

validatorOutputs: TOutputs;

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

Schema outputs and createOutput payloads from this submission, ordered by validator index. Skipped validators and successful returns without an output contribute undefined.

Example

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

value

value: TFormData;

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

The form values for this submission.