UNPKG

32 kBMarkdownView Raw
1# `react-router`
2
3## 6.26.1
4
5### Patch Changes
6
7- Rename `unstable_patchRoutesOnMiss` to `unstable_patchRoutesOnNavigation` to match new behavior ([#11888](https://github.com/remix-run/react-router/pull/11888))
8- Updated dependencies:
9 - `@remix-run/router@1.19.1`
10
11## 6.26.0
12
13### Minor Changes
14
15- Add a new `replace(url, init?)` alternative to `redirect(url, init?)` that performs a `history.replaceState` instead of a `history.pushState` on client-side navigation redirects ([#11811](https://github.com/remix-run/react-router/pull/11811))
16
17### Patch Changes
18
19- Fix initial hydration behavior when using `future.v7_partialHydration` along with `unstable_patchRoutesOnMiss` ([#11838](https://github.com/remix-run/react-router/pull/11838))
20 - During initial hydration, `router.state.matches` will now include any partial matches so that we can render ancestor `HydrateFallback` components
21- Updated dependencies:
22 - `@remix-run/router@1.19.0`
23
24## 6.25.1
25
26No significant changes to this package were made in this release. [See the repo `CHANGELOG.md`](https://github.com/remix-run/react-router/blob/main/CHANGELOG.md) for an overview of all changes in v6.25.1.
27
28## 6.25.0
29
30### Minor Changes
31
32- Stabilize `future.unstable_skipActionErrorRevalidation` as `future.v7_skipActionErrorRevalidation` ([#11769](https://github.com/remix-run/react-router/pull/11769))
33 - When this flag is enabled, actions will not automatically trigger a revalidation if they return/throw a `Response` with a `4xx`/`5xx` status code
34 - You may still opt-into revalidation via `shouldRevalidate`
35 - This also changes `shouldRevalidate`'s `unstable_actionStatus` parameter to `actionStatus`
36
37### Patch Changes
38
39- Fix regression and properly decode paths inside `useMatch` so matches/params reflect decoded params ([#11789](https://github.com/remix-run/react-router/pull/11789))
40- Updated dependencies:
41 - `@remix-run/router@1.18.0`
42
43## 6.24.1
44
45### Patch Changes
46
47- When using `future.v7_relativeSplatPath`, properly resolve relative paths in splat routes that are children of pathless routes ([#11633](https://github.com/remix-run/react-router/pull/11633))
48- Updated dependencies:
49 - `@remix-run/router@1.17.1`
50
51## 6.24.0
52
53### Minor Changes
54
55- Add support for Lazy Route Discovery (a.k.a. Fog of War) ([#11626](https://github.com/remix-run/react-router/pull/11626))
56 - RFC: <https://github.com/remix-run/react-router/discussions/11113>
57 - `unstable_patchRoutesOnMiss` docs: <https://reactrouter.com/en/main/routers/create-browser-router>
58
59### Patch Changes
60
61- Updated dependencies:
62 - `@remix-run/router@1.17.0`
63
64## 6.23.1
65
66### Patch Changes
67
68- allow undefined to be resolved with `<Await>` ([#11513](https://github.com/remix-run/react-router/pull/11513))
69- Updated dependencies:
70 - `@remix-run/router@1.16.1`
71
72## 6.23.0
73
74### Minor Changes
75
76- Add a new `unstable_dataStrategy` configuration option ([#11098](https://github.com/remix-run/react-router/pull/11098))
77 - This option allows Data Router applications to take control over the approach for executing route loaders and actions
78 - The default implementation is today's behavior, to fetch all loaders in parallel, but this option allows users to implement more advanced data flows including Remix single-fetch, middleware/context APIs, automatic loader caching, and more
79
80### Patch Changes
81
82- Updated dependencies:
83 - `@remix-run/router@1.16.0`
84
85## 6.22.3
86
87### Patch Changes
88
89- Updated dependencies:
90 - `@remix-run/router@1.15.3`
91
92## 6.22.2
93
94### Patch Changes
95
96- Updated dependencies:
97 - `@remix-run/router@1.15.2`
98
99## 6.22.1
100
101### Patch Changes
102
103- Fix encoding/decoding issues with pre-encoded dynamic parameter values ([#11199](https://github.com/remix-run/react-router/pull/11199))
104- Updated dependencies:
105 - `@remix-run/router@1.15.1`
106
107## 6.22.0
108
109### Patch Changes
110
111- Updated dependencies:
112 - `@remix-run/router@1.15.0`
113
114## 6.21.3
115
116### Patch Changes
117
118- Remove leftover `unstable_` prefix from `Blocker`/`BlockerFunction` types ([#11187](https://github.com/remix-run/react-router/pull/11187))
119
120## 6.21.2
121
122### Patch Changes
123
124- Updated dependencies:
125 - `@remix-run/router@1.14.2`
126
127## 6.21.1
128
129### Patch Changes
130
131- Fix bug with `route.lazy` not working correctly on initial SPA load when `v7_partialHydration` is specified ([#11121](https://github.com/remix-run/react-router/pull/11121))
132- Updated dependencies:
133 - `@remix-run/router@1.14.1`
134
135## 6.21.0
136
137### Minor Changes
138
139- Add a new `future.v7_relativeSplatPath` flag to implement a breaking bug fix to relative routing when inside a splat route. ([#11087](https://github.com/remix-run/react-router/pull/11087))
140
141 This fix was originally added in [#10983](https://github.com/remix-run/react-router/issues/10983) and was later reverted in [#11078](https://github.com/remix-run/react-router/pull/11078) because it was determined that a large number of existing applications were relying on the buggy behavior (see [#11052](https://github.com/remix-run/react-router/issues/11052))
142
143 **The Bug**
144 The buggy behavior is that without this flag, the default behavior when resolving relative paths is to _ignore_ any splat (`*`) portion of the current route path.
145
146 **The Background**
147 This decision was originally made thinking that it would make the concept of nested different sections of your apps in `<Routes>` easier if relative routing would _replace_ the current splat:
148
149 ```jsx
150 <BrowserRouter>
151 <Routes>
152 <Route path="/" element={<Home />} />
153 <Route path="dashboard/*" element={<Dashboard />} />
154 </Routes>
155 </BrowserRouter>
156 ```
157
158 Any paths like `/dashboard`, `/dashboard/team`, `/dashboard/projects` will match the `Dashboard` route. The dashboard component itself can then render nested `<Routes>`:
159
160 ```jsx
161 function Dashboard() {
162 return (
163 <div>
164 <h2>Dashboard</h2>
165 <nav>
166 <Link to="/">Dashboard Home</Link>
167 <Link to="team">Team</Link>
168 <Link to="projects">Projects</Link>
169 </nav>
170
171 <Routes>
172 <Route path="/" element={<DashboardHome />} />
173 <Route path="team" element={<DashboardTeam />} />
174 <Route path="projects" element={<DashboardProjects />} />
175 </Routes>
176 </div>
177 );
178 }
179 ```
180
181 Now, all links and route paths are relative to the router above them. This makes code splitting and compartmentalizing your app really easy. You could render the `Dashboard` as its own independent app, or embed it into your large app without making any changes to it.
182
183 **The Problem**
184
185 The problem is that this concept of ignoring part of a path breaks a lot of other assumptions in React Router - namely that `"."` always means the current location pathname for that route. When we ignore the splat portion, we start getting invalid paths when using `"."`:
186
187 ```jsx
188 // If we are on URL /dashboard/team, and we want to link to /dashboard/team:
189 function DashboardTeam() {
190 // ❌ This is broken and results in <a href="/dashboard">
191 return <Link to=".">A broken link to the Current URL</Link>;
192
193 // ✅ This is fixed but super unintuitive since we're already at /dashboard/team!
194 return <Link to="./team">A broken link to the Current URL</Link>;
195 }
196 ```
197
198 We've also introduced an issue that we can no longer move our `DashboardTeam` component around our route hierarchy easily - since it behaves differently if we're underneath a non-splat route, such as `/dashboard/:widget`. Now, our `"."` links will, properly point to ourself _inclusive of the dynamic param value_ so behavior will break from it's corresponding usage in a `/dashboard/*` route.
199
200 Even worse, consider a nested splat route configuration:
201
202 ```jsx
203 <BrowserRouter>
204 <Routes>
205 <Route path="dashboard">
206 <Route path="*" element={<Dashboard />} />
207 </Route>
208 </Routes>
209 </BrowserRouter>
210 ```
211
212 Now, a `<Link to=".">` and a `<Link to="..">` inside the `Dashboard` component go to the same place! That is definitely not correct!
213
214 Another common issue arose in Data Routers (and Remix) where any `<Form>` should post to it's own route `action` if you the user doesn't specify a form action:
215
216 ```jsx
217 let router = createBrowserRouter({
218 path: "/dashboard",
219 children: [
220 {
221 path: "*",
222 action: dashboardAction,
223 Component() {
224 // ❌ This form is broken! It throws a 405 error when it submits because
225 // it tries to submit to /dashboard (without the splat value) and the parent
226 // `/dashboard` route doesn't have an action
227 return <Form method="post">...</Form>;
228 },
229 },
230 ],
231 });
232 ```
233
234 This is just a compounded issue from the above because the default location for a `Form` to submit to is itself (`"."`) - and if we ignore the splat portion, that now resolves to the parent route.
235
236 **The Solution**
237 If you are leveraging this behavior, it's recommended to enable the future flag, move your splat to it's own route, and leverage `../` for any links to "sibling" pages:
238
239 ```jsx
240 <BrowserRouter>
241 <Routes>
242 <Route path="dashboard">
243 <Route index path="*" element={<Dashboard />} />
244 </Route>
245 </Routes>
246 </BrowserRouter>
247
248 function Dashboard() {
249 return (
250 <div>
251 <h2>Dashboard</h2>
252 <nav>
253 <Link to="..">Dashboard Home</Link>
254 <Link to="../team">Team</Link>
255 <Link to="../projects">Projects</Link>
256 </nav>
257
258 <Routes>
259 <Route path="/" element={<DashboardHome />} />
260 <Route path="team" element={<DashboardTeam />} />
261 <Route path="projects" element={<DashboardProjects />} />
262 </Router>
263 </div>
264 );
265 }
266 ```
267
268 This way, `.` means "the full current pathname for my route" in all cases (including static, dynamic, and splat routes) and `..` always means "my parents pathname".
269
270### Patch Changes
271
272- Properly handle falsy error values in ErrorBoundary's ([#11071](https://github.com/remix-run/react-router/pull/11071))
273- Updated dependencies:
274 - `@remix-run/router@1.14.0`
275
276## 6.20.1
277
278### Patch Changes
279
280- Revert the `useResolvedPath` fix for splat routes due to a large number of applications that were relying on the buggy behavior (see <https://github.com/remix-run/react-router/issues/11052#issuecomment-1836589329>). We plan to re-introduce this fix behind a future flag in the next minor version. ([#11078](https://github.com/remix-run/react-router/pull/11078))
281- Updated dependencies:
282 - `@remix-run/router@1.13.1`
283
284## 6.20.0
285
286### Minor Changes
287
288- Export the `PathParam` type from the public API ([#10719](https://github.com/remix-run/react-router/pull/10719))
289
290### Patch Changes
291
292- Fix bug with `resolveTo` in splat routes ([#11045](https://github.com/remix-run/react-router/pull/11045))
293 - This is a follow up to [#10983](https://github.com/remix-run/react-router/pull/10983) to handle the few other code paths using `getPathContributingMatches`
294 - This removes the `UNSAFE_getPathContributingMatches` export from `@remix-run/router` since we no longer need this in the `react-router`/`react-router-dom` layers
295- Updated dependencies:
296 - `@remix-run/router@1.13.0`
297
298## 6.19.0
299
300### Minor Changes
301
302- Add `unstable_flushSync` option to `useNavigate`/`useSumbit`/`fetcher.load`/`fetcher.submit` to opt-out of `React.startTransition` and into `ReactDOM.flushSync` for state updates ([#11005](https://github.com/remix-run/react-router/pull/11005))
303- Remove the `unstable_` prefix from the [`useBlocker`](https://reactrouter.com/en/main/hooks/use-blocker) hook as it's been in use for enough time that we are confident in the API. We do not plan to remove the prefix from `unstable_usePrompt` due to differences in how browsers handle `window.confirm` that prevent React Router from guaranteeing consistent/correct behavior. ([#10991](https://github.com/remix-run/react-router/pull/10991))
304
305### Patch Changes
306
307- Fix `useActionData` so it returns proper contextual action data and not _any_ action data in the tree ([#11023](https://github.com/remix-run/react-router/pull/11023))
308
309- Fix bug in `useResolvedPath` that would cause `useResolvedPath(".")` in a splat route to lose the splat portion of the URL path. ([#10983](https://github.com/remix-run/react-router/pull/10983))
310
311 - ⚠️ This fixes a quite long-standing bug specifically for `"."` paths inside a splat route which incorrectly dropped the splat portion of the URL. If you are relative routing via `"."` inside a splat route in your application you should double check that your logic is not relying on this buggy behavior and update accordingly.
312
313- Updated dependencies:
314 - `@remix-run/router@1.12.0`
315
316## 6.18.0
317
318### Patch Changes
319
320- Fix the `future` prop on `BrowserRouter`, `HashRouter` and `MemoryRouter` so that it accepts a `Partial<FutureConfig>` instead of requiring all flags to be included. ([#10962](https://github.com/remix-run/react-router/pull/10962))
321- Updated dependencies:
322 - `@remix-run/router@1.11.0`
323
324## 6.17.0
325
326### Patch Changes
327
328- Fix `RouterProvider` `future` prop type to be a `Partial<FutureConfig>` so that not all flags must be specified ([#10900](https://github.com/remix-run/react-router/pull/10900))
329- Updated dependencies:
330 - `@remix-run/router@1.10.0`
331
332## 6.16.0
333
334### Minor Changes
335
336- In order to move towards stricter TypeScript support in the future, we're aiming to replace current usages of `any` with `unknown` on exposed typings for user-provided data. To do this in Remix v2 without introducing breaking changes in React Router v6, we have added generics to a number of shared types. These continue to default to `any` in React Router and are overridden with `unknown` in Remix. In React Router v7 we plan to move these to `unknown` as a breaking change. ([#10843](https://github.com/remix-run/react-router/pull/10843))
337 - `Location` now accepts a generic for the `location.state` value
338 - `ActionFunctionArgs`/`ActionFunction`/`LoaderFunctionArgs`/`LoaderFunction` now accept a generic for the `context` parameter (only used in SSR usages via `createStaticHandler`)
339 - The return type of `useMatches` (now exported as `UIMatch`) accepts generics for `match.data` and `match.handle` - both of which were already set to `unknown`
340- Move the `@private` class export `ErrorResponse` to an `UNSAFE_ErrorResponseImpl` export since it is an implementation detail and there should be no construction of `ErrorResponse` instances in userland. This frees us up to export a `type ErrorResponse` which correlates to an instance of the class via `InstanceType`. Userland code should only ever be using `ErrorResponse` as a type and should be type-narrowing via `isRouteErrorResponse`. ([#10811](https://github.com/remix-run/react-router/pull/10811))
341- Export `ShouldRevalidateFunctionArgs` interface ([#10797](https://github.com/remix-run/react-router/pull/10797))
342- Removed private/internal APIs only required for the Remix v1 backwards compatibility layer and no longer needed in Remix v2 (`_isFetchActionRedirect`, `_hasFetcherDoneAnything`) ([#10715](https://github.com/remix-run/react-router/pull/10715))
343
344### Patch Changes
345
346- Updated dependencies:
347 - `@remix-run/router@1.9.0`
348
349## 6.15.0
350
351### Minor Changes
352
353- Add's a new `redirectDocument()` function which allows users to specify that a redirect from a `loader`/`action` should trigger a document reload (via `window.location`) instead of attempting to navigate to the redirected location via React Router ([#10705](https://github.com/remix-run/react-router/pull/10705))
354
355### Patch Changes
356
357- Ensure `useRevalidator` is referentially stable across re-renders if revalidations are not actively occurring ([#10707](https://github.com/remix-run/react-router/pull/10707))
358- Updated dependencies:
359 - `@remix-run/router@1.8.0`
360
361## 6.14.2
362
363### Patch Changes
364
365- Updated dependencies:
366 - `@remix-run/router@1.7.2`
367
368## 6.14.1
369
370### Patch Changes
371
372- Fix loop in `unstable_useBlocker` when used with an unstable blocker function ([#10652](https://github.com/remix-run/react-router/pull/10652))
373- Fix issues with reused blockers on subsequent navigations ([#10656](https://github.com/remix-run/react-router/pull/10656))
374- Updated dependencies:
375 - `@remix-run/router@1.7.1`
376
377## 6.14.0
378
379### Patch Changes
380
381- Strip `basename` from locations provided to `unstable_useBlocker` functions to match `useLocation` ([#10573](https://github.com/remix-run/react-router/pull/10573))
382- Fix `generatePath` when passed a numeric `0` value parameter ([#10612](https://github.com/remix-run/react-router/pull/10612))
383- Fix `unstable_useBlocker` key issues in `StrictMode` ([#10573](https://github.com/remix-run/react-router/pull/10573))
384- Fix `tsc --skipLibCheck:false` issues on React 17 ([#10622](https://github.com/remix-run/react-router/pull/10622))
385- Upgrade `typescript` to 5.1 ([#10581](https://github.com/remix-run/react-router/pull/10581))
386- Updated dependencies:
387 - `@remix-run/router@1.7.0`
388
389## 6.13.0
390
391### Minor Changes
392
393- Move [`React.startTransition`](https://react.dev/reference/react/startTransition) usage behind a [future flag](https://reactrouter.com/en/main/guides/api-development-strategy) to avoid issues with existing incompatible `Suspense` usages. We recommend folks adopting this flag to be better compatible with React concurrent mode, but if you run into issues you can continue without the use of `startTransition` until v7. Issues usually boils down to creating net-new promises during the render cycle, so if you run into issues you should either lift your promise creation out of the render cycle or put it behind a `useMemo`. ([#10596](https://github.com/remix-run/react-router/pull/10596))
394
395 Existing behavior will no longer include `React.startTransition`:
396
397 ```jsx
398 <BrowserRouter>
399 <Routes>{/*...*/}</Routes>
400 </BrowserRouter>
401
402 <RouterProvider router={router} />
403 ```
404
405 If you wish to enable `React.startTransition`, pass the future flag to your component:
406
407 ```jsx
408 <BrowserRouter future={{ v7_startTransition: true }}>
409 <Routes>{/*...*/}</Routes>
410 </BrowserRouter>
411
412 <RouterProvider router={router} future={{ v7_startTransition: true }}/>
413 ```
414
415### Patch Changes
416
417- Work around webpack/terser `React.startTransition` minification bug in production mode ([#10588](https://github.com/remix-run/react-router/pull/10588))
418
419## 6.12.1
420
421> \[!WARNING]
422> Please use version `6.13.0` or later instead of `6.12.1`. This version suffers from a `webpack`/`terser` minification issue resulting in invalid minified code in your resulting production bundles which can cause issues in your application. See [#10579](https://github.com/remix-run/react-router/issues/10579) for more details.
423
424### Patch Changes
425
426- Adjust feature detection of `React.startTransition` to fix webpack + react 17 compilation error ([#10569](https://github.com/remix-run/react-router/pull/10569))
427
428## 6.12.0
429
430### Minor Changes
431
432- Wrap internal router state updates with `React.startTransition` if it exists ([#10438](https://github.com/remix-run/react-router/pull/10438))
433
434### Patch Changes
435
436- Updated dependencies:
437 - `@remix-run/router@1.6.3`
438
439## 6.11.2
440
441### Patch Changes
442
443- Fix `basename` duplication in descendant `<Routes>` inside a `<RouterProvider>` ([#10492](https://github.com/remix-run/react-router/pull/10492))
444- Updated dependencies:
445 - `@remix-run/router@1.6.2`
446
447## 6.11.1
448
449### Patch Changes
450
451- Fix usage of `Component` API within descendant `<Routes>` ([#10434](https://github.com/remix-run/react-router/pull/10434))
452- Fix bug when calling `useNavigate` from `<Routes>` inside a `<RouterProvider>` ([#10432](https://github.com/remix-run/react-router/pull/10432))
453- Fix usage of `<Navigate>` in strict mode when using a data router ([#10435](https://github.com/remix-run/react-router/pull/10435))
454- Updated dependencies:
455 - `@remix-run/router@1.6.1`
456
457## 6.11.0
458
459### Patch Changes
460
461- Log loader/action errors to the console in dev for easier stack trace evaluation ([#10286](https://github.com/remix-run/react-router/pull/10286))
462- Fix bug preventing rendering of descendant `<Routes>` when `RouterProvider` errors existed ([#10374](https://github.com/remix-run/react-router/pull/10374))
463- Fix inadvertent re-renders when using `Component` instead of `element` on a route definition ([#10287](https://github.com/remix-run/react-router/pull/10287))
464- Fix detection of `useNavigate` in the render cycle by setting the `activeRef` in a layout effect, allowing the `navigate` function to be passed to child components and called in a `useEffect` there. ([#10394](https://github.com/remix-run/react-router/pull/10394))
465- Switched from `useSyncExternalStore` to `useState` for internal `@remix-run/router` router state syncing in `<RouterProvider>`. We found some [subtle bugs](https://codesandbox.io/s/use-sync-external-store-loop-9g7b81) where router state updates got propagated _before_ other normal `useState` updates, which could lead to footguns in `useEffect` calls. ([#10377](https://github.com/remix-run/react-router/pull/10377), [#10409](https://github.com/remix-run/react-router/pull/10409))
466- Allow `useRevalidator()` to resolve a loader-driven error boundary scenario ([#10369](https://github.com/remix-run/react-router/pull/10369))
467- Avoid unnecessary unsubscribe/resubscribes on router state changes ([#10409](https://github.com/remix-run/react-router/pull/10409))
468- When using a `RouterProvider`, `useNavigate`/`useSubmit`/`fetcher.submit` are now stable across location changes, since we can handle relative routing via the `@remix-run/router` instance and get rid of our dependence on `useLocation()`. When using `BrowserRouter`, these hooks remain unstable across location changes because they still rely on `useLocation()`. ([#10336](https://github.com/remix-run/react-router/pull/10336))
469- Updated dependencies:
470 - `@remix-run/router@1.6.0`
471
472## 6.10.0
473
474### Minor Changes
475
476- Added support for [**Future Flags**](https://reactrouter.com/en/main/guides/api-development-strategy) in React Router. The first flag being introduced is `future.v7_normalizeFormMethod` which will normalize the exposed `useNavigation()/useFetcher()` `formMethod` fields as uppercase HTTP methods to align with the `fetch()` behavior. ([#10207](https://github.com/remix-run/react-router/pull/10207))
477
478 - When `future.v7_normalizeFormMethod === false` (default v6 behavior),
479 - `useNavigation().formMethod` is lowercase
480 - `useFetcher().formMethod` is lowercase
481 - When `future.v7_normalizeFormMethod === true`:
482 - `useNavigation().formMethod` is uppercase
483 - `useFetcher().formMethod` is uppercase
484
485### Patch Changes
486
487- Fix route ID generation when using Fragments in `createRoutesFromElements` ([#10193](https://github.com/remix-run/react-router/pull/10193))
488- Updated dependencies:
489 - `@remix-run/router@1.5.0`
490
491## 6.9.0
492
493### Minor Changes
494
495- React Router now supports an alternative way to define your route `element` and `errorElement` fields as React Components instead of React Elements. You can instead pass a React Component to the new `Component` and `ErrorBoundary` fields if you choose. There is no functional difference between the two, so use whichever approach you prefer 😀. You shouldn't be defining both, but if you do `Component`/`ErrorBoundary` will "win". ([#10045](https://github.com/remix-run/react-router/pull/10045))
496
497 **Example JSON Syntax**
498
499 ```jsx
500 // Both of these work the same:
501 const elementRoutes = [{
502 path: '/',
503 element: <Home />,
504 errorElement: <HomeError />,
505 }]
506
507 const componentRoutes = [{
508 path: '/',
509 Component: Home,
510 ErrorBoundary: HomeError,
511 }]
512
513 function Home() { ... }
514 function HomeError() { ... }
515 ```
516
517 **Example JSX Syntax**
518
519 ```jsx
520 // Both of these work the same:
521 const elementRoutes = createRoutesFromElements(
522 <Route path='/' element={<Home />} errorElement={<HomeError /> } />
523 );
524
525 const componentRoutes = createRoutesFromElements(
526 <Route path='/' Component={Home} ErrorBoundary={HomeError} />
527 );
528
529 function Home() { ... }
530 function HomeError() { ... }
531 ```
532
533- **Introducing Lazy Route Modules!** ([#10045](https://github.com/remix-run/react-router/pull/10045))
534
535 In order to keep your application bundles small and support code-splitting of your routes, we've introduced a new `lazy()` route property. This is an async function that resolves the non-route-matching portions of your route definition (`loader`, `action`, `element`/`Component`, `errorElement`/`ErrorBoundary`, `shouldRevalidate`, `handle`).
536
537 Lazy routes are resolved on initial load and during the `loading` or `submitting` phase of a navigation or fetcher call. You cannot lazily define route-matching properties (`path`, `index`, `children`) since we only execute your lazy route functions after we've matched known routes.
538
539 Your `lazy` functions will typically return the result of a dynamic import.
540
541 ```jsx
542 // In this example, we assume most folks land on the homepage so we include that
543 // in our critical-path bundle, but then we lazily load modules for /a and /b so
544 // they don't load until the user navigates to those routes
545 let routes = createRoutesFromElements(
546 <Route path="/" element={<Layout />}>
547 <Route index element={<Home />} />
548 <Route path="a" lazy={() => import("./a")} />
549 <Route path="b" lazy={() => import("./b")} />
550 </Route>
551 );
552 ```
553
554 Then in your lazy route modules, export the properties you want defined for the route:
555
556 ```jsx
557 export async function loader({ request }) {
558 let data = await fetchData(request);
559 return json(data);
560 }
561
562 // Export a `Component` directly instead of needing to create a React Element from it
563 export function Component() {
564 let data = useLoaderData();
565
566 return (
567 <>
568 <h1>You made it!</h1>
569 <p>{data}</p>
570 </>
571 );
572 }
573
574 // Export an `ErrorBoundary` directly instead of needing to create a React Element from it
575 export function ErrorBoundary() {
576 let error = useRouteError();
577 return isRouteErrorResponse(error) ? (
578 <h1>
579 {error.status} {error.statusText}
580 </h1>
581 ) : (
582 <h1>{error.message || error}</h1>
583 );
584 }
585 ```
586
587 An example of this in action can be found in the [`examples/lazy-loading-router-provider`](https://github.com/remix-run/react-router/tree/main/examples/lazy-loading-router-provider) directory of the repository.
588
589 🙌 Huge thanks to @rossipedia for the [Initial Proposal](https://github.com/remix-run/react-router/discussions/9826) and [POC Implementation](https://github.com/remix-run/react-router/pull/9830).
590
591- Updated dependencies:
592 - `@remix-run/router@1.4.0`
593
594### Patch Changes
595
596- Fix `generatePath` incorrectly applying parameters in some cases ([#10078](https://github.com/remix-run/react-router/pull/10078))
597- Improve memoization for context providers to avoid unnecessary re-renders ([#9983](https://github.com/remix-run/react-router/pull/9983))
598
599## 6.8.2
600
601### Patch Changes
602
603- Updated dependencies:
604 - `@remix-run/router@1.3.3`
605
606## 6.8.1
607
608### Patch Changes
609
610- Remove inaccurate console warning for POP navigations and update active blocker logic ([#10030](https://github.com/remix-run/react-router/pull/10030))
611- Updated dependencies:
612 - `@remix-run/router@1.3.2`
613
614## 6.8.0
615
616### Patch Changes
617
618- Updated dependencies:
619 - `@remix-run/router@1.3.1`
620
621## 6.7.0
622
623### Minor Changes
624
625- Add `unstable_useBlocker` hook for blocking navigations within the app's location origin ([#9709](https://github.com/remix-run/react-router/pull/9709))
626
627### Patch Changes
628
629- Fix `generatePath` when optional params are present ([#9764](https://github.com/remix-run/react-router/pull/9764))
630- Update `<Await>` to accept `ReactNode` as children function return result ([#9896](https://github.com/remix-run/react-router/pull/9896))
631- Updated dependencies:
632 - `@remix-run/router@1.3.0`
633
634## 6.6.2
635
636### Patch Changes
637
638- Ensure `useId` consistency during SSR ([#9805](https://github.com/remix-run/react-router/pull/9805))
639
640## 6.6.1
641
642### Patch Changes
643
644- Updated dependencies:
645 - `@remix-run/router@1.2.1`
646
647## 6.6.0
648
649### Patch Changes
650
651- Prevent `useLoaderData` usage in `errorElement` ([#9735](https://github.com/remix-run/react-router/pull/9735))
652- Updated dependencies:
653 - `@remix-run/router@1.2.0`
654
655## 6.5.0
656
657This release introduces support for [Optional Route Segments](https://github.com/remix-run/react-router/issues/9546). Now, adding a `?` to the end of any path segment will make that entire segment optional. This works for both static segments and dynamic parameters.
658
659**Optional Params Examples**
660
661- `<Route path=":lang?/about>` will match:
662 - `/:lang/about`
663 - `/about`
664- `<Route path="/multistep/:widget1?/widget2?/widget3?">` will match:
665 - `/multistep`
666 - `/multistep/:widget1`
667 - `/multistep/:widget1/:widget2`
668 - `/multistep/:widget1/:widget2/:widget3`
669
670**Optional Static Segment Example**
671
672- `<Route path="/home?">` will match:
673 - `/`
674 - `/home`
675- `<Route path="/fr?/about">` will match:
676 - `/about`
677 - `/fr/about`
678
679### Minor Changes
680
681- Allows optional routes and optional static segments ([#9650](https://github.com/remix-run/react-router/pull/9650))
682
683### Patch Changes
684
685- Stop incorrectly matching on partial named parameters, i.e. `<Route path="prefix-:param">`, to align with how splat parameters work. If you were previously relying on this behavior then it's recommended to extract the static portion of the path at the `useParams` call site: ([#9506](https://github.com/remix-run/react-router/pull/9506))
686
687```jsx
688// Old behavior at URL /prefix-123
689<Route path="prefix-:id" element={<Comp /> }>
690
691function Comp() {
692 let params = useParams(); // { id: '123' }
693 let id = params.id; // "123"
694 ...
695}
696
697// New behavior at URL /prefix-123
698<Route path=":id" element={<Comp /> }>
699
700function Comp() {
701 let params = useParams(); // { id: 'prefix-123' }
702 let id = params.id.replace(/^prefix-/, ''); // "123"
703 ...
704}
705```
706
707- Updated dependencies:
708 - `@remix-run/router@1.1.0`
709
710## 6.4.5
711
712### Patch Changes
713
714- Updated dependencies:
715 - `@remix-run/router@1.0.5`
716
717## 6.4.4
718
719### Patch Changes
720
721- Updated dependencies:
722 - `@remix-run/router@1.0.4`
723
724## 6.4.3
725
726### Patch Changes
727
728- `useRoutes` should be able to return `null` when passing `locationArg` ([#9485](https://github.com/remix-run/react-router/pull/9485))
729- fix `initialEntries` type in `createMemoryRouter` ([#9498](https://github.com/remix-run/react-router/pull/9498))
730- Updated dependencies:
731 - `@remix-run/router@1.0.3`
732
733## 6.4.2
734
735### Patch Changes
736
737- Fix `IndexRouteObject` and `NonIndexRouteObject` types to make `hasErrorElement` optional ([#9394](https://github.com/remix-run/react-router/pull/9394))
738- Enhance console error messages for invalid usage of data router hooks ([#9311](https://github.com/remix-run/react-router/pull/9311))
739- If an index route has children, it will result in a runtime error. We have strengthened our `RouteObject`/`RouteProps` types to surface the error in TypeScript. ([#9366](https://github.com/remix-run/react-router/pull/9366))
740- Updated dependencies:
741 - `@remix-run/router@1.0.2`
742
743## 6.4.1
744
745### Patch Changes
746
747- Preserve state from `initialEntries` ([#9288](https://github.com/remix-run/react-router/pull/9288))
748- Updated dependencies:
749 - `@remix-run/router@1.0.1`
750
751## 6.4.0
752
753Whoa this is a big one! `6.4.0` brings all the data loading and mutation APIs over from Remix. Here's a quick high level overview, but it's recommended you go check out the [docs](https://reactrouter.com), especially the [feature overview](https://reactrouter.com/start/overview) and the [tutorial](https://reactrouter.com/start/tutorial).
754
755**New APIs**
756
757- Create your router with `createMemoryRouter`
758- Render your router with `<RouterProvider>`
759- Load data with a Route `loader` and mutate with a Route `action`
760- Handle errors with Route `errorElement`
761- Defer non-critical data with `defer` and `Await`
762
763**Bug Fixes**
764
765- Path resolution is now trailing slash agnostic (#8861)
766- `useLocation` returns the scoped location inside a `<Routes location>` component (#9094)
767
768**Updated Dependencies**
769
770- `@remix-run/router@1.0.0`