React Router v7 Best Practices
Quick Reference
Router Setup (Data Mode):
import { createBrowserRouter, RouterProvider } from "react-router";
const router = createBrowserRouter([
{
path: "/",
Component: Root,
ErrorBoundary: RootErrorBoundary,
loader: rootLoader,
children: [
{ index: true, Component: Home },
{ path: "products/:productId", Component: Product, loader: productLoader },
],
},
]);
ReactDOM.createRoot(root).render(<RouterProvider router={router} />);
Framework Mode (Vite plugin):
// routes.ts
import { index, route } from "@react-router/dev/routes";
export default [
index("./home.tsx"),
route("products/:pid", "./product.tsx"),
];
Route Configuration
Nested Routes with Outlets
createBrowserRouter([
{
path: "/dashboard",
Component: Dashboard,
children: [
{ index: true, Component: DashboardHome },
{ path: "settings", Component: Settings },
],
},
]);
function Dashboard() {
return (
<div>
<h1>Dashboard</h1>
<Outlet /> {/* Renders child routes */}
</div>
);
}
Dynamic Segments and Splats
{ path: "teams/:teamId" } // params.teamId
{ path: ":lang?/categories" } // Optional segment
{ path: "files/*" } // Splat: params["*"]
Key Decision Points
Form vs Fetcher
Use <Form>: Creating/deleting with URL change, adding to history
Use useFetcher: Inline updates, list operations, popovers - no URL change
Loader vs useEffect
Use loader: Data before render, server-side fetch, automatic revalidation
Use useEffect: Client-only data, user-interaction dependent, subscriptions
Gates (decision sequencing)
Answer in order. Pass means the condition is true; pick the API on the same line and stop.
<Form> vs useFetcher
- Must the URL or history stack change (bookmark/share, back returns to prior screen)?
- Pass →
<Form> / route action (or useSubmit + navigation). Stop.
- Fail → Step 2.
- Mutation stays on the same route (inline edit, modal, list row, no address change)?
- Pass →
useFetcher(). Stop.
- Fail → Re-check step 1; you may need a dedicated action route or POST to the current URL.
loader vs useEffect
- Is data needed for correct first render (or your intended
<Suspense> boundary) for this route?
- Pass →
loader (Framework: clientLoader when appropriate). Stop.
- Fail → Step 2.
- Fetch only after mount from user action, timer, or subscription (not route entry)?
- Pass →
useEffect / event handlers. Stop.
- Fail → Prefer loader + revalidation over an effect that mirrors navigation.
Additional Documentation
- Data Loading: See references/loaders.md for loader patterns, parallel loading, search params
- Mutations: See references/actions.md for actions, Form, fetchers, validation
- Navigation: See references/navigation.md for Link, NavLink, programmatic nav
- Advanced: See references/advanced.md for error boundaries, protected routes, lazy loading
Mode Comparison
| Feature |
Framework Mode |
Data Mode |
Declarative Mode |
| Setup |
Vite plugin |
createBrowserRouter |
<BrowserRouter> |
| Type Safety |
Auto-generated types |
Manual |
Manual |
| SSR Support |
Built-in |
Manual |
Limited |
| Use Case |
Full-stack apps |
SPAs with control |
Simple/legacy |
1---
2name: react-router-v7
3description: React Router v7 best practices for data-driven routing. Use when implementing routes, loaders, actions, Form components, fetchers, navigation guards, protected routes, or URL search params. Triggers on createBrowserRouter, RouterProvider, useLoaderData, useActionData, useFetcher, NavLink, Outlet.
4metadata:
5 source: https://skillmd.com/skills/existential-birds/react-router-v7
6---
7
8# React Router v7 Best Practices
9
10## Quick Reference
11
12**Router Setup (Data Mode)**:
13```tsx
14import { createBrowserRouter, RouterProvider } from "react-router";
15
16const router = createBrowserRouter([
17 {
18 path: "/",
19 Component: Root,
20 ErrorBoundary: RootErrorBoundary,
21 loader: rootLoader,
22 children: [
23 { index: true, Component: Home },
24 { path: "products/:productId", Component: Product, loader: productLoader },
25 ],
26 },
27]);
28
29ReactDOM.createRoot(root).render(<RouterProvider router={router} />);
30```
31
32**Framework Mode (Vite plugin)**:
33```ts
34// routes.ts
35import { index, route } from "@react-router/dev/routes";
36
37export default [
38 index("./home.tsx"),
39 route("products/:pid", "./product.tsx"),
40];
41```
42
43## Route Configuration
44
45### Nested Routes with Outlets
46
47```tsx
48createBrowserRouter([
49 {
50 path: "/dashboard",
51 Component: Dashboard,
52 children: [
53 { index: true, Component: DashboardHome },
54 { path: "settings", Component: Settings },
55 ],
56 },
57]);
58
59function Dashboard() {
60 return (
61 <div>
62 <h1>Dashboard</h1>
63 <Outlet /> {/* Renders child routes */}
64 </div>
65 );
66}
67```
68
69### Dynamic Segments and Splats
70
71```tsx
72{ path: "teams/:teamId" } // params.teamId
73{ path: ":lang?/categories" } // Optional segment
74{ path: "files/*" } // Splat: params["*"]
75```
76
77## Key Decision Points
78
79### Form vs Fetcher
80
81**Use `<Form>`**: Creating/deleting with URL change, adding to history
82**Use `useFetcher`**: Inline updates, list operations, popovers - no URL change
83
84### Loader vs useEffect
85
86**Use loader**: Data before render, server-side fetch, automatic revalidation
87**Use useEffect**: Client-only data, user-interaction dependent, subscriptions
88
89## Gates (decision sequencing)
90
91Answer **in order**. **Pass** means the condition is true; pick the API on the same line and **stop**.
92
93### `<Form>` vs `useFetcher`
94
951. **Must the URL or history stack change** (bookmark/share, back returns to prior screen)?
96 - **Pass →** `<Form>` / route `action` (or `useSubmit` + navigation). **Stop.**
97 - **Fail →** Step 2.
982. **Mutation stays on the same route** (inline edit, modal, list row, no address change)?
99 - **Pass →** `useFetcher()`. **Stop.**
100 - **Fail →** Re-check step 1; you may need a dedicated action route or POST to the current URL.
101
102### `loader` vs `useEffect`
103
1041. **Is data needed for correct first render** (or your intended `<Suspense>` boundary) for this route?
105 - **Pass →** `loader` (Framework: `clientLoader` when appropriate). **Stop.**
106 - **Fail →** Step 2.
1072. **Fetch only after mount** from user action, timer, or subscription (not route entry)?
108 - **Pass →** `useEffect` / event handlers. **Stop.**
109 - **Fail →** Prefer loader + revalidation over an effect that mirrors navigation.
110
111## Additional Documentation
112
113- **Data Loading**: See [references/loaders.md](references/loaders.md) for loader patterns, parallel loading, search params
114- **Mutations**: See [references/actions.md](references/actions.md) for actions, Form, fetchers, validation
115- **Navigation**: See [references/navigation.md](references/navigation.md) for Link, NavLink, programmatic nav
116- **Advanced**: See [references/advanced.md](references/advanced.md) for error boundaries, protected routes, lazy loading
117
118## Mode Comparison
119
120| Feature | Framework Mode | Data Mode | Declarative Mode |
121|---------|---------------|-----------|------------------|
122| Setup | Vite plugin | `createBrowserRouter` | `<BrowserRouter>` |
123| Type Safety | Auto-generated types | Manual | Manual |
124| SSR Support | Built-in | Manual | Limited |
125| Use Case | Full-stack apps | SPAs with control | Simple/legacy |