-
-
Notifications
You must be signed in to change notification settings - Fork 468
Docs: Add error handling section to submission handling docs #1566
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
f186229
19196cd
3b47efe
835d6c6
9cc5382
f0aebe9
0e5be7b
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
@@ -3,6 +3,79 @@ id: submission-handling | |||||||||||||
title: Submission handling | ||||||||||||||
--- | ||||||||||||||
|
||||||||||||||
## Error handling | ||||||||||||||
|
||||||||||||||
When a user submits a form, there are several ways errors can occur — each requiring its own handling approach. TanStack Form gives you the flexibility to handle errors your way. To help you get started, here’s how to approach the three most common types of errors you’ll run into: | ||||||||||||||
|
||||||||||||||
- **Synchronous user errors** – Issues you can catch right away, like a field being left empty or text that's too short. | ||||||||||||||
- **Asynchronous user errors** – Issues that come up after submission, like finding out a username is already taken. | ||||||||||||||
- **Server errors** – Unexpected problems on the backend, such as a failed request or an unknown error. | ||||||||||||||
|
||||||||||||||
> [!TIP] | ||||||||||||||
> If you need help understanding how validation works in TanStack Form, be sure to check out the [form validation](../validation.md) guide! | ||||||||||||||
|
||||||||||||||
### Synchronous user errors | ||||||||||||||
|
||||||||||||||
These are validation issues that can be detected immediately on the client side, even before the form is submitted. They are typically managed using both form-level and field-level validators, as shown in the example below: | ||||||||||||||
|
||||||||||||||
```tsx | ||||||||||||||
<form.Field | ||||||||||||||
name="age" | ||||||||||||||
validators={{ | ||||||||||||||
onChange: ({ value }) => | ||||||||||||||
value < 13 ? 'You must be 13 to make an account' : undefined, | ||||||||||||||
}} | ||||||||||||||
children={{() => <>{/* ... */}</>}} | ||||||||||||||
/> | ||||||||||||||
``` | ||||||||||||||
|
||||||||||||||
### Asynchronous user errors | ||||||||||||||
|
||||||||||||||
Asynchronous errors usually occur after the form is submitted, often due to external checks — like verifying whether a username or email is already taken. These kinds of errors can be handled using the async variants of form and field validators. | ||||||||||||||
|
||||||||||||||
Since these requests are usually at form level, see how you can [set field-level errors from the form's validators](../validation.md). | ||||||||||||||
|
||||||||||||||
```tsx | ||||||||||||||
const form = useForm({ | ||||||||||||||
// ... | ||||||||||||||
validators: { | ||||||||||||||
onSubmitAsync: async ({ value }) => { | ||||||||||||||
// Validate the value on the server | ||||||||||||||
const response = await createAccount(value) | ||||||||||||||
|
||||||||||||||
if (response.isError) { | ||||||||||||||
// Username is taken, return an error for the username field | ||||||||||||||
return 'Username is already taken!' | ||||||||||||||
} | ||||||||||||||
// The account creation was a success. There is no error that needs to be shown. | ||||||||||||||
return null | ||||||||||||||
}, | ||||||||||||||
}, | ||||||||||||||
}) | ||||||||||||||
``` | ||||||||||||||
|
||||||||||||||
### Server errors | ||||||||||||||
|
||||||||||||||
Server errors are unexpected failures that happen during submission — like connectivity issues or internal server faults. These aren't related to user input and therefore **should not be part of form validation**. | ||||||||||||||
|
||||||||||||||
These kinds of errors are typically handled by an external library, such as `TanStack Query`: | ||||||||||||||
|
||||||||||||||
```tsx | ||||||||||||||
// Using TanStack Query for data mutations | ||||||||||||||
const createAccountMutation = useMutation({ | ||||||||||||||
/* ... */ | ||||||||||||||
}) | ||||||||||||||
|
||||||||||||||
const form = useForm({ | ||||||||||||||
// ... | ||||||||||||||
onSubmit: async ({ value }) => { | ||||||||||||||
// If an error happens, they are accessible through | ||||||||||||||
// `createAccountMutation.error` | ||||||||||||||
await createAccountMutation.mutateAsync(value) | ||||||||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Promoting "mutateAsync" here feels off:
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Here's the thought process behind it:
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Then this seems like one of those exceptions to not prefere It's perfect as it is, thanks for clarifying! There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Do you reckon this should be mentioned somewhere? I assume there's lots of users combining Tanstack Form with TansStack Query There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. There's some explenation here: https://tanstack.com/form/latest/docs/reference/type-aliases/baseformstate#issubmitting I think it would be good to mention it on the "Submission Handling"-Page as well as it clears up a lot of questions. |
||||||||||||||
}, | ||||||||||||||
}) | ||||||||||||||
``` | ||||||||||||||
|
||||||||||||||
## Passing additional data to submission handling | ||||||||||||||
|
||||||||||||||
You may have multiple types of submission behaviour, for example, going back to another page or staying on the form. | ||||||||||||||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This says
but the error seems to go to the Form not to the Field
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good catch! The comment is kind of redundant now. I'll remove it!