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

error-boundaries.md

53 lines1.3 KB

1---
2id: error-boundaries
3title: Error Boundaries
4---
5​
6## Error Boundaries (React Start)
7​
8TanStack Start uses TanStack Router's route-level error boundaries.
9​
10- Set a default for all routes via the router
11- Override per-route with `errorComponent`
12​
13### Configure a default
14​
15```tsx
16// src/router.tsx
17import { createRouter, ErrorComponent } from '@tanstack/react-router'
18import { routeTree } from './routeTree.gen'
19​
20export function getRouter() {
21 const router = createRouter({
22 routeTree,
23 // Shown when an error bubbles to the router
24 defaultErrorComponent: ({ error, reset }) => (
25 <ErrorComponent error={error} />
26 ),
27 })
28 return router
30```
31​
32### Per-route override
33​
34```tsx
35// src/routes/posts.$postId.tsx
36import { createFileRoute, ErrorComponent } from '@tanstack/react-router'
37import type { ErrorComponentProps } from '@tanstack/react-router'
38​
39function PostError({ error, reset }: ErrorComponentProps) {
40 return <ErrorComponent error={error} />
42​
43export const Route = createFileRoute('/posts/$postId')({
44 component: PostComponent,
45 errorComponent: PostError,
46})
47```
48​
49Notes:
50​
51- `ErrorComponent` is a simple built-in UI you can replace.
52- Call `reset()` to retry rendering the route after fixing state.
53- Use `beforeLoad`/`loader` to throw errors that will be caught.