UNPKG

47.6 kB Markdown View Raw
1 # `react-router`
2
3 ## 7.0.1
4
5 ## 7.0.0
6
7 ### Major Changes
8
9 - Remove the original `defer` implementation in favor of using raw promises via single fetch and `turbo-stream`. This removes these exports from React Router: ([#11744](https://github.com/remix-run/react-router/pull/11744))
10
11 - `defer`
12 - `AbortedDeferredError`
13 - `type TypedDeferredData`
14 - `UNSAFE_DeferredData`
15 - `UNSAFE_DEFERRED_SYMBOL`,
16
17 - - Collapse `@remix-run/router` into `react-router` ([#11505](https://github.com/remix-run/react-router/pull/11505))
18 - Collapse `react-router-dom` into `react-router`
19 - Collapse `@remix-run/server-runtime` into `react-router`
20 - Collapse `@remix-run/testing` into `react-router`
21
22 - Remove single\_fetch future flag. ([#11522](https://github.com/remix-run/react-router/pull/11522))
23
24 - Drop support for Node 16, React Router SSR now requires Node 18 or higher ([#11391](https://github.com/remix-run/react-router/pull/11391))
25
26 - Remove `future.v7_startTransition` flag ([#11696](https://github.com/remix-run/react-router/pull/11696))
27
28 - - Expose the underlying router promises from the following APIs for compsition in React 19 APIs: ([#11521](https://github.com/remix-run/react-router/pull/11521))
29 - `useNavigate()`
30 - `useSubmit`
31 - `useFetcher().load`
32 - `useFetcher().submit`
33 - `useRevalidator.revalidate`
34
35 - Remove `future.v7_normalizeFormMethod` future flag ([#11697](https://github.com/remix-run/react-router/pull/11697))
36
37 - For Remix consumers migrating to React Router, the `crypto` global from the [Web Crypto API](https://developer.mozilla.org/en-US/docs/Web/API/Web_Crypto_API) is now required when using cookie and session APIs. This means that the following APIs are provided from `react-router` rather than platform-specific packages: ([#11837](https://github.com/remix-run/react-router/pull/11837))
38
39 - `createCookie`
40 - `createCookieSessionStorage`
41 - `createMemorySessionStorage`
42 - `createSessionStorage`
43
44 For consumers running older versions of Node, the `installGlobals` function from `@remix-run/node` has been updated to define `globalThis.crypto`, using [Node's `require('node:crypto').webcrypto` implementation.](https://nodejs.org/api/webcrypto.html)
45
46 Since platform-specific packages no longer need to implement this API, the following low-level APIs have been removed:
47
48 - `createCookieFactory`
49 - `createSessionStorageFactory`
50 - `createCookieSessionStorageFactory`
51 - `createMemorySessionStorageFactory`
52
53 - Imports/Exports cleanup ([#11840](https://github.com/remix-run/react-router/pull/11840))
54
55 - Removed the following exports that were previously public API from `@remix-run/router`
56 - types
57 - `AgnosticDataIndexRouteObject`
58 - `AgnosticDataNonIndexRouteObject`
59 - `AgnosticDataRouteMatch`
60 - `AgnosticDataRouteObject`
61 - `AgnosticIndexRouteObject`
62 - `AgnosticNonIndexRouteObject`
63 - `AgnosticRouteMatch`
64 - `AgnosticRouteObject`
65 - `TrackedPromise`
66 - `unstable_AgnosticPatchRoutesOnMissFunction`
67 - `Action` -> exported as `NavigationType` via `react-router`
68 - `Router` exported as `DataRouter` to differentiate from RR's `<Router>`
69 - API
70 - `getToPathname` (`@private`)
71 - `joinPaths` (`@private`)
72 - `normalizePathname` (`@private`)
73 - `resolveTo` (`@private`)
74 - `stripBasename` (`@private`)
75 - `createBrowserHistory` -> in favor of `createBrowserRouter`
76 - `createHashHistory` -> in favor of `createHashRouter`
77 - `createMemoryHistory` -> in favor of `createMemoryRouter`
78 - `createRouter`
79 - `createStaticHandler` -> in favor of wrapper `createStaticHandler` in RR Dom
80 - `getStaticContextFromError`
81 - Removed the following exports that were previously public API from `react-router`
82 - `Hash`
83 - `Pathname`
84 - `Search`
85
86 - update minimum node version to 18 ([#11690](https://github.com/remix-run/react-router/pull/11690))
87
88 - Remove `future.v7_prependBasename` from the ionternalized `@remix-run/router` package ([#11726](https://github.com/remix-run/react-router/pull/11726))
89
90 - Migrate Remix type generics to React Router ([#12180](https://github.com/remix-run/react-router/pull/12180))
91
92 - These generics are provided for Remix v2 migration purposes
93 - These generics and the APIs they exist on should be considered informally deprecated in favor of the new `Route.*` types
94 - Anyone migrating from React Router v6 should probably not leverage these new generics and should migrate straight to the `Route.*` types
95 - For React Router v6 users, these generics are new and should not impact your app, with one exception
96 - `useFetcher` previously had an optional generic (used primarily by Remix v2) that expected the data type
97 - This has been updated in v7 to expect the type of the function that generates the data (i.e., `typeof loader`/`typeof action`)
98 - Therefore, you should update your usages:
99 - ❌ `useFetcher<LoaderData>()`
100 - ✅ `useFetcher<typeof loader>()`
101
102 - Remove `future.v7_throwAbortReason` from internalized `@remix-run/router` package ([#11728](https://github.com/remix-run/react-router/pull/11728))
103
104 - Add `exports` field to all packages ([#11675](https://github.com/remix-run/react-router/pull/11675))
105
106 - node package no longer re-exports from react-router ([#11702](https://github.com/remix-run/react-router/pull/11702))
107
108 - renamed RemixContext to FrameworkContext ([#11705](https://github.com/remix-run/react-router/pull/11705))
109
110 - updates the minimum React version to 18 ([#11689](https://github.com/remix-run/react-router/pull/11689))
111
112 - PrefetchPageDescriptor replaced by PageLinkDescriptor ([#11960](https://github.com/remix-run/react-router/pull/11960))
113
114 - - Consolidate types previously duplicated across `@remix-run/router`, `@remix-run/server-runtime`, and `@remix-run/react` now that they all live in `react-router` ([#12177](https://github.com/remix-run/react-router/pull/12177))
115 - Examples: `LoaderFunction`, `LoaderFunctionArgs`, `ActionFunction`, `ActionFunctionArgs`, `DataFunctionArgs`, `RouteManifest`, `LinksFunction`, `Route`, `EntryRoute`
116 - The `RouteManifest` type used by the "remix" code is now slightly stricter because it is using the former `@remix-run/router` `RouteManifest`
117 - `Record<string, Route> -> Record<string, Route | undefined>`
118 - Removed `AppData` type in favor of inlining `unknown` in the few locations it was used
119 - Removed `ServerRuntimeMeta*` types in favor of the `Meta*` types they were duplicated from
120
121 - - Remove the `future.v7_partialHydration` flag ([#11725](https://github.com/remix-run/react-router/pull/11725))
122 - This also removes the `<RouterProvider fallbackElement>` prop
123 - To migrate, move the `fallbackElement` to a `hydrateFallbackElement`/`HydrateFallback` on your root route
124 - Also worth nothing there is a related breaking changer with this future flag:
125 - Without `future.v7_partialHydration` (when using `fallbackElement`), `state.navigation` was populated during the initial load
126 - With `future.v7_partialHydration`, `state.navigation` remains in an `"idle"` state during the initial load
127
128 - Remove `v7_relativeSplatPath` future flag ([#11695](https://github.com/remix-run/react-router/pull/11695))
129
130 - Drop support for Node 18, update minimum Node vestion to 20 ([#12171](https://github.com/remix-run/react-router/pull/12171))
131
132 - Remove `installGlobals()` as this should no longer be necessary
133
134 - Remove remaining future flags ([#11820](https://github.com/remix-run/react-router/pull/11820))
135
136 - React Router `v7_skipActionErrorRevalidation`
137 - Remix `v3_fetcherPersist`, `v3_relativeSplatPath`, `v3_throwAbortReason`
138
139 - rename createRemixStub to createRoutesStub ([#11692](https://github.com/remix-run/react-router/pull/11692))
140
141 - Remove `@remix-run/router` deprecated `detectErrorBoundary` option in favor of `mapRouteProperties` ([#11751](https://github.com/remix-run/react-router/pull/11751))
142
143 - Add `react-router/dom` subpath export to properly enable `react-dom` as an optional `peerDependency` ([#11851](https://github.com/remix-run/react-router/pull/11851))
144
145 - This ensures that we don't blindly `import ReactDOM from "react-dom"` in `<RouterProvider>` in order to access `ReactDOM.flushSync()`, since that would break `createMemoryRouter` use cases in non-DOM environments
146 - DOM environments should import from `react-router/dom` to get the proper component that makes `ReactDOM.flushSync()` available:
147 - If you are using the Vite plugin, use this in your `entry.client.tsx`:
148 - `import { HydratedRouter } from 'react-router/dom'`
149 - If you are not using the Vite plugin and are manually calling `createBrowserRouter`/`createHashRouter`:
150 - `import { RouterProvider } from "react-router/dom"`
151
152 - Remove `future.v7_fetcherPersist` flag ([#11731](https://github.com/remix-run/react-router/pull/11731))
153
154 - Update `cookie` dependency to `^1.0.1` - please see the [release notes](https://github.com/jshttp/cookie/releases) for any breaking changes ([#12172](https://github.com/remix-run/react-router/pull/12172))
155
156 ### Minor Changes
157
158 - - Add support for `prerender` config in the React Router vite plugin, to support existing SSG use-cases ([#11539](https://github.com/remix-run/react-router/pull/11539))
159 - You can use the `prerender` config to pre-render your `.html` and `.data` files at build time and then serve them statically at runtime (either from a running server or a CDN)
160 - `prerender` can either be an array of string paths, or a function (sync or async) that returns an array of strings so that you can dynamically generate the paths by talking to your CMS, etc.
161
162 ```ts
163 // react-router.config.ts
164 import type { Config } from "@react-router/dev/config";
165
166 export default {
167 async prerender() {
168 let slugs = await fakeGetSlugsFromCms();
169 // Prerender these paths into `.html` files at build time, and `.data`
170 // files if they have loaders
171 return ["/", "/about", ...slugs.map((slug) => `/product/${slug}`)];
172 },
173 } satisfies Config;
174
175 async function fakeGetSlugsFromCms() {
176 await new Promise((r) => setTimeout(r, 1000));
177 return ["shirt", "hat"];
178 }
179 ```
180
181 - Params, loader data, and action data as props for route component exports ([#11961](https://github.com/remix-run/react-router/pull/11961))
182
183 ```tsx
184 export default function Component({ params, loaderData, actionData }) {}
185
186 export function HydrateFallback({ params }) {}
187 export function ErrorBoundary({ params, loaderData, actionData }) {}
188 ```
189
190 - Remove duplicate `RouterProvider` impliementations ([#11679](https://github.com/remix-run/react-router/pull/11679))
191
192 - ### Typesafety improvements ([#12019](https://github.com/remix-run/react-router/pull/12019))
193
194 React Router now generates types for each of your route modules.
195 You can access those types by importing them from `./+types.<route filename without extension>`.
196 For example:
197
198 ```ts
199 // app/routes/product.tsx
200 import type * as Route from "./+types.product";
201
202 export function loader({ params }: Route.LoaderArgs) {}
203
204 export default function Component({ loaderData }: Route.ComponentProps) {}
205 ```
206
207 This initial implementation targets type inference for:
208
209 - `Params` : Path parameters from your routing config in `routes.ts` including file-based routing
210 - `LoaderData` : Loader data from `loader` and/or `clientLoader` within your route module
211 - `ActionData` : Action data from `action` and/or `clientAction` within your route module
212
213 In the future, we plan to add types for the rest of the route module exports: `meta`, `links`, `headers`, `shouldRevalidate`, etc.
214 We also plan to generate types for typesafe `Link`s:
215
216 ```tsx
217
218 // ^^^^^^^^^^^^^ ^^^^^^^^^
219 // typesafe `to` and `params` based on the available routes in your app
220 ```
221
222 Check out our docs for more:
223
224 - [_Explanations > Type Safety_](https://reactrouter.com/dev/guides/explanation/type-safety)
225 - [_How-To > Setting up type safety_](https://reactrouter.com/dev/guides/how-to/setting-up-type-safety)
226
227 - Stabilize `unstable_dataStrategy` ([#11969](https://github.com/remix-run/react-router/pull/11969))
228
229 - Stabilize `unstable_patchRoutesOnNavigation` ([#11970](https://github.com/remix-run/react-router/pull/11970))
230
231 ### Patch Changes
232
233 - No changes ([`506329c4e`](https://github.com/remix-run/react-router/commit/506329c4e2e7aba9837cbfa44df6103b49423745))
234
235 - chore: re-enable development warnings through a `development` exports condition. ([#12269](https://github.com/remix-run/react-router/pull/12269))
236
237 - Remove unstable upload handler. ([#12015](https://github.com/remix-run/react-router/pull/12015))
238
239 - Remove unneeded dependency on @web3-storage/multipart-parser ([#12274](https://github.com/remix-run/react-router/pull/12274))
240
241 - Fix redirects returned from loaders/actions using `data()` ([#12021](https://github.com/remix-run/react-router/pull/12021))
242
243 - fix(react-router): (v7) fix static prerender of non-ascii characters ([#12161](https://github.com/remix-run/react-router/pull/12161))
244
245 - Replace `substr` with `substring` ([#12080](https://github.com/remix-run/react-router/pull/12080))
246
247 - Remove the deprecated `json` utility ([#12146](https://github.com/remix-run/react-router/pull/12146))
248
249 - You can use [`Response.json`](https://developer.mozilla.org/en-US/docs/Web/API/Response/json_static) if you still need to construct JSON responses in your app
250
251 - Remove unneeded dependency on source-map ([#12275](https://github.com/remix-run/react-router/pull/12275))
252
253 ## 6.28.0
254
255 ### Minor Changes
256
257 - - Log deprecation warnings for v7 flags ([#11750](https://github.com/remix-run/react-router/pull/11750))
258 - Add deprecation warnings to `json`/`defer` in favor of returning raw objects
259 - These methods will be removed in React Router v7
260
261 ### Patch Changes
262
263 - Update JSDoc URLs for new website structure (add /v6/ segment) ([#12141](https://github.com/remix-run/react-router/pull/12141))
264 - Updated dependencies:
265 - `@remix-run/router@1.21.0`
266
267 ## 6.27.0
268
269 ### Minor Changes
270
271 - Stabilize `unstable_patchRoutesOnNavigation` ([#11973](https://github.com/remix-run/react-router/pull/11973))
272 - Add new `PatchRoutesOnNavigationFunctionArgs` type for convenience ([#11967](https://github.com/remix-run/react-router/pull/11967))
273 - Stabilize `unstable_dataStrategy` ([#11974](https://github.com/remix-run/react-router/pull/11974))
274 - Stabilize the `unstable_flushSync` option for navigations and fetchers ([#11989](https://github.com/remix-run/react-router/pull/11989))
275 - Stabilize the `unstable_viewTransition` option for navigations and the corresponding `unstable_useViewTransitionState` hook ([#11989](https://github.com/remix-run/react-router/pull/11989))
276
277 ### Patch Changes
278
279 - Fix bug when submitting to the current contextual route (parent route with an index child) when an `?index` param already exists from a prior submission ([#12003](https://github.com/remix-run/react-router/pull/12003))
280
281 - Fix `useFormAction` bug - when removing `?index` param it would not keep other non-Remix `index` params ([#12003](https://github.com/remix-run/react-router/pull/12003))
282
283 - Fix types for `RouteObject` within `PatchRoutesOnNavigationFunction`'s `patch` method so it doesn't expect agnostic route objects passed to `patch` ([#11967](https://github.com/remix-run/react-router/pull/11967))
284
285 - Updated dependencies:
286 - `@remix-run/router@1.20.0`
287
288 ## 6.26.2
289
290 ### Patch Changes
291
292 - Updated dependencies:
293 - `@remix-run/router@1.19.2`
294
295 ## 6.26.1
296
297 ### Patch Changes
298
299 - Rename `unstable_patchRoutesOnMiss` to `unstable_patchRoutesOnNavigation` to match new behavior ([#11888](https://github.com/remix-run/react-router/pull/11888))
300 - Updated dependencies:
301 - `@remix-run/router@1.19.1`
302
303 ## 6.26.0
304
305 ### Minor Changes
306
307 - 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))
308
309 ### Patch Changes
310
311 - Fix initial hydration behavior when using `future.v7_partialHydration` along with `unstable_patchRoutesOnMiss` ([#11838](https://github.com/remix-run/react-router/pull/11838))
312 - During initial hydration, `router.state.matches` will now include any partial matches so that we can render ancestor `HydrateFallback` components
313 - Updated dependencies:
314 - `@remix-run/router@1.19.0`
315
316 ## 6.25.1
317
318 No 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.
319
320 ## 6.25.0
321
322 ### Minor Changes
323
324 - Stabilize `future.unstable_skipActionErrorRevalidation` as `future.v7_skipActionErrorRevalidation` ([#11769](https://github.com/remix-run/react-router/pull/11769))
325 - When this flag is enabled, actions will not automatically trigger a revalidation if they return/throw a `Response` with a `4xx`/`5xx` status code
326 - You may still opt-into revalidation via `shouldRevalidate`
327 - This also changes `shouldRevalidate`'s `unstable_actionStatus` parameter to `actionStatus`
328
329 ### Patch Changes
330
331 - Fix regression and properly decode paths inside `useMatch` so matches/params reflect decoded params ([#11789](https://github.com/remix-run/react-router/pull/11789))
332 - Updated dependencies:
333 - `@remix-run/router@1.18.0`
334
335 ## 6.24.1
336
337 ### Patch Changes
338
339 - 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))
340 - Updated dependencies:
341 - `@remix-run/router@1.17.1`
342
343 ## 6.24.0
344
345 ### Minor Changes
346
347 - Add support for Lazy Route Discovery (a.k.a. Fog of War) ([#11626](https://github.com/remix-run/react-router/pull/11626))
348 - RFC:
349 - `unstable_patchRoutesOnMiss` docs:
350
351 ### Patch Changes
352
353 - Updated dependencies:
354 - `@remix-run/router@1.17.0`
355
356 ## 6.23.1
357
358 ### Patch Changes
359
360 - allow undefined to be resolved with `<Await>` ([#11513](https://github.com/remix-run/react-router/pull/11513))
361 - Updated dependencies:
362 - `@remix-run/router@1.16.1`
363
364 ## 6.23.0
365
366 ### Minor Changes
367
368 - Add a new `unstable_dataStrategy` configuration option ([#11098](https://github.com/remix-run/react-router/pull/11098))
369 - This option allows Data Router applications to take control over the approach for executing route loaders and actions
370 - 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
371
372 ### Patch Changes
373
374 - Updated dependencies:
375 - `@remix-run/router@1.16.0`
376
377 ## 6.22.3
378
379 ### Patch Changes
380
381 - Updated dependencies:
382 - `@remix-run/router@1.15.3`
383
384 ## 6.22.2
385
386 ### Patch Changes
387
388 - Updated dependencies:
389 - `@remix-run/router@1.15.2`
390
391 ## 6.22.1
392
393 ### Patch Changes
394
395 - Fix encoding/decoding issues with pre-encoded dynamic parameter values ([#11199](https://github.com/remix-run/react-router/pull/11199))
396 - Updated dependencies:
397 - `@remix-run/router@1.15.1`
398
399 ## 6.22.0
400
401 ### Patch Changes
402
403 - Updated dependencies:
404 - `@remix-run/router@1.15.0`
405
406 ## 6.21.3
407
408 ### Patch Changes
409
410 - Remove leftover `unstable_` prefix from `Blocker`/`BlockerFunction` types ([#11187](https://github.com/remix-run/react-router/pull/11187))
411
412 ## 6.21.2
413
414 ### Patch Changes
415
416 - Updated dependencies:
417 - `@remix-run/router@1.14.2`
418
419 ## 6.21.1
420
421 ### Patch Changes
422
423 - 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))
424 - Updated dependencies:
425 - `@remix-run/router@1.14.1`
426
427 ## 6.21.0
428
429 ### Minor Changes
430
431 - 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))
432
433 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))
434
435 **The Bug**
436 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.
437
438 **The Background**
439 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:
440
441 ```jsx
442
443 <Routes>
444 <Route path="/" element={<Home />} />
445 <Route path="dashboard/*" element={<Dashboard />} />
446 </Routes>
447
448 ```
449
450 Any paths like `/dashboard`, `/dashboard/team`, `/dashboard/projects` will match the `Dashboard` route. The dashboard component itself can then render nested `<Routes>`:
451
452 ```jsx
453 function Dashboard() {
454 return (
455 <div>
456 <h2>Dashboard</h2>
457 <nav>
458 <Link to="/">Dashboard Home</Link>
459 <Link to="team">Team</Link>
460 <Link to="projects">Projects</Link>
461 </nav>
462
463 <Routes>
464 <Route path="/" element={<DashboardHome />} />
465 <Route path="team" element={<DashboardTeam />} />
466 <Route path="projects" element={<DashboardProjects />} />
467 </Routes>
468 </div>
469 );
470 }
471 ```
472
473 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.
474
475 **The Problem**
476
477 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 `"."`:
478
479 ```jsx
480 // If we are on URL /dashboard/team, and we want to link to /dashboard/team:
481 function DashboardTeam() {
482 // ❌ This is broken and results in <a href="/dashboard">
483 return <Link to=".">A broken link to the Current URL</Link>;
484
485 // ✅ This is fixed but super unintuitive since we're already at /dashboard/team!
486 return <Link to="./team">A broken link to the Current URL</Link>;
487 }
488 ```
489
490 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.
491
492 Even worse, consider a nested splat route configuration:
493
494 ```jsx
495
496 <Routes>
497 <Route path="dashboard">
498 <Route path="*" element={<Dashboard />} />
499 </Route>
500 </Routes>
501
502 ```
503
504 Now, a `<Link to=".">` and a `<Link to="..">` inside the `Dashboard` component go to the same place! That is definitely not correct!
505
506 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:
507
508 ```jsx
509 let router = createBrowserRouter({
510 path: "/dashboard",
511 children: [
512 {
513 path: "*",
514 action: dashboardAction,
515 Component() {
516 // ❌ This form is broken! It throws a 405 error when it submits because
517 // it tries to submit to /dashboard (without the splat value) and the parent
518 // `/dashboard` route doesn't have an action
519 return <Form method="post">...</Form>;
520 },
521 },
522 ],
523 });
524 ```
525
526 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.
527
528 **The Solution**
529 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:
530
531 ```jsx
532
533 <Routes>
534 <Route path="dashboard">
535 <Route index path="*" element={<Dashboard />} />
536 </Route>
537 </Routes>
538
539
540 function Dashboard() {
541 return (
542 <div>
543 <h2>Dashboard</h2>
544 <nav>
545 <Link to="..">Dashboard Home</Link>
546 <Link to="../team">Team</Link>
547 <Link to="../projects">Projects</Link>
548 </nav>
549
550 <Routes>
551 <Route path="/" element={<DashboardHome />} />
552 <Route path="team" element={<DashboardTeam />} />
553 <Route path="projects" element={<DashboardProjects />} />
554 </Router>
555 </div>
556 );
557 }
558 ```
559
560 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".
561
562 ### Patch Changes
563
564 - Properly handle falsy error values in ErrorBoundary's ([#11071](https://github.com/remix-run/react-router/pull/11071))
565 - Updated dependencies:
566 - `@remix-run/router@1.14.0`
567
568 ## 6.20.1
569
570 ### Patch Changes
571
572 - Revert the `useResolvedPath` fix for splat routes due to a large number of applications that were relying on the buggy behavior (see ). 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))
573 - Updated dependencies:
574 - `@remix-run/router@1.13.1`
575
576 ## 6.20.0
577
578 ### Minor Changes
579
580 - Export the `PathParam` type from the public API ([#10719](https://github.com/remix-run/react-router/pull/10719))
581
582 ### Patch Changes
583
584 - Fix bug with `resolveTo` in splat routes ([#11045](https://github.com/remix-run/react-router/pull/11045))
585 - 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`
586 - This removes the `UNSAFE_getPathContributingMatches` export from `@remix-run/router` since we no longer need this in the `react-router`/`react-router-dom` layers
587 - Updated dependencies:
588 - `@remix-run/router@1.13.0`
589
590 ## 6.19.0
591
592 ### Minor Changes
593
594 - 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))
595 - Remove the `unstable_` prefix from the [`useBlocker`](https://reactrouter.com/v6/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))
596
597 ### Patch Changes
598
599 - 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))
600
601 - 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))
602
603 - ⚠️ 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.
604
605 - Updated dependencies:
606 - `@remix-run/router@1.12.0`
607
608 ## 6.18.0
609
610 ### Patch Changes
611
612 - 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))
613 - Updated dependencies:
614 - `@remix-run/router@1.11.0`
615
616 ## 6.17.0
617
618 ### Patch Changes
619
620 - 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))
621 - Updated dependencies:
622 - `@remix-run/router@1.10.0`
623
624 ## 6.16.0
625
626 ### Minor Changes
627
628 - 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))
629 - `Location` now accepts a generic for the `location.state` value
630 - `ActionFunctionArgs`/`ActionFunction`/`LoaderFunctionArgs`/`LoaderFunction` now accept a generic for the `context` parameter (only used in SSR usages via `createStaticHandler`)
631 - 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`
632 - 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))
633 - Export `ShouldRevalidateFunctionArgs` interface ([#10797](https://github.com/remix-run/react-router/pull/10797))
634 - 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))
635
636 ### Patch Changes
637
638 - Updated dependencies:
639 - `@remix-run/router@1.9.0`
640
641 ## 6.15.0
642
643 ### Minor Changes
644
645 - 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))
646
647 ### Patch Changes
648
649 - Ensure `useRevalidator` is referentially stable across re-renders if revalidations are not actively occurring ([#10707](https://github.com/remix-run/react-router/pull/10707))
650 - Updated dependencies:
651 - `@remix-run/router@1.8.0`
652
653 ## 6.14.2
654
655 ### Patch Changes
656
657 - Updated dependencies:
658 - `@remix-run/router@1.7.2`
659
660 ## 6.14.1
661
662 ### Patch Changes
663
664 - Fix loop in `unstable_useBlocker` when used with an unstable blocker function ([#10652](https://github.com/remix-run/react-router/pull/10652))
665 - Fix issues with reused blockers on subsequent navigations ([#10656](https://github.com/remix-run/react-router/pull/10656))
666 - Updated dependencies:
667 - `@remix-run/router@1.7.1`
668
669 ## 6.14.0
670
671 ### Patch Changes
672
673 - Strip `basename` from locations provided to `unstable_useBlocker` functions to match `useLocation` ([#10573](https://github.com/remix-run/react-router/pull/10573))
674 - Fix `generatePath` when passed a numeric `0` value parameter ([#10612](https://github.com/remix-run/react-router/pull/10612))
675 - Fix `unstable_useBlocker` key issues in `StrictMode` ([#10573](https://github.com/remix-run/react-router/pull/10573))
676 - Fix `tsc --skipLibCheck:false` issues on React 17 ([#10622](https://github.com/remix-run/react-router/pull/10622))
677 - Upgrade `typescript` to 5.1 ([#10581](https://github.com/remix-run/react-router/pull/10581))
678 - Updated dependencies:
679 - `@remix-run/router@1.7.0`
680
681 ## 6.13.0
682
683 ### Minor Changes
684
685 - Move [`React.startTransition`](https://react.dev/reference/react/startTransition) usage behind a [future flag](https://reactrouter.com/v6/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))
686
687 Existing behavior will no longer include `React.startTransition`:
688
689 ```jsx
690
691 <Routes>{/*...*/}</Routes>
692
693
694
695 ```
696
697 If you wish to enable `React.startTransition`, pass the future flag to your component:
698
699 ```jsx
700
701 <Routes>{/*...*/}</Routes>
702
703
704
705 ```
706
707 ### Patch Changes
708
709 - Work around webpack/terser `React.startTransition` minification bug in production mode ([#10588](https://github.com/remix-run/react-router/pull/10588))
710
711 ## 6.12.1
712
713 > \[!WARNING]
714 > 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.
715
716 ### Patch Changes
717
718 - Adjust feature detection of `React.startTransition` to fix webpack + react 17 compilation error ([#10569](https://github.com/remix-run/react-router/pull/10569))
719
720 ## 6.12.0
721
722 ### Minor Changes
723
724 - Wrap internal router state updates with `React.startTransition` if it exists ([#10438](https://github.com/remix-run/react-router/pull/10438))
725
726 ### Patch Changes
727
728 - Updated dependencies:
729 - `@remix-run/router@1.6.3`
730
731 ## 6.11.2
732
733 ### Patch Changes
734
735 - Fix `basename` duplication in descendant `<Routes>` inside a `<RouterProvider>` ([#10492](https://github.com/remix-run/react-router/pull/10492))
736 - Updated dependencies:
737 - `@remix-run/router@1.6.2`
738
739 ## 6.11.1
740
741 ### Patch Changes
742
743 - Fix usage of `Component` API within descendant `<Routes>` ([#10434](https://github.com/remix-run/react-router/pull/10434))
744 - Fix bug when calling `useNavigate` from `<Routes>` inside a `<RouterProvider>` ([#10432](https://github.com/remix-run/react-router/pull/10432))
745 - Fix usage of `<Navigate>` in strict mode when using a data router ([#10435](https://github.com/remix-run/react-router/pull/10435))
746 - Updated dependencies:
747 - `@remix-run/router@1.6.1`
748
749 ## 6.11.0
750
751 ### Patch Changes
752
753 - Log loader/action errors to the console in dev for easier stack trace evaluation ([#10286](https://github.com/remix-run/react-router/pull/10286))
754 - Fix bug preventing rendering of descendant `<Routes>` when `RouterProvider` errors existed ([#10374](https://github.com/remix-run/react-router/pull/10374))
755 - Fix inadvertent re-renders when using `Component` instead of `element` on a route definition ([#10287](https://github.com/remix-run/react-router/pull/10287))
756 - 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))
757 - 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))
758 - Allow `useRevalidator()` to resolve a loader-driven error boundary scenario ([#10369](https://github.com/remix-run/react-router/pull/10369))
759 - Avoid unnecessary unsubscribe/resubscribes on router state changes ([#10409](https://github.com/remix-run/react-router/pull/10409))
760 - 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))
761 - Updated dependencies:
762 - `@remix-run/router@1.6.0`
763
764 ## 6.10.0
765
766 ### Minor Changes
767
768 - Added support for [**Future Flags**](https://reactrouter.com/v6/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))
769
770 - When `future.v7_normalizeFormMethod === false` (default v6 behavior),
771 - `useNavigation().formMethod` is lowercase
772 - `useFetcher().formMethod` is lowercase
773 - When `future.v7_normalizeFormMethod === true`:
774 - `useNavigation().formMethod` is uppercase
775 - `useFetcher().formMethod` is uppercase
776
777 ### Patch Changes
778
779 - Fix route ID generation when using Fragments in `createRoutesFromElements` ([#10193](https://github.com/remix-run/react-router/pull/10193))
780 - Updated dependencies:
781 - `@remix-run/router@1.5.0`
782
783 ## 6.9.0
784
785 ### Minor Changes
786
787 - 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))
788
789 **Example JSON Syntax**
790
791 ```jsx
792 // Both of these work the same:
793 const elementRoutes = [{
794 path: '/',
795 element: <Home />,
796 errorElement: <HomeError />,
797 }]
798
799 const componentRoutes = [{
800 path: '/',
801 Component: Home,
802 ErrorBoundary: HomeError,
803 }]
804
805 function Home() { ... }
806 function HomeError() { ... }
807 ```
808
809 **Example JSX Syntax**
810
811 ```jsx
812 // Both of these work the same:
813 const elementRoutes = createRoutesFromElements(
814 <Route path='/' element={<Home />} errorElement={<HomeError /> } />
815 );
816
817 const componentRoutes = createRoutesFromElements(
818 <Route path='/' Component={Home} ErrorBoundary={HomeError} />
819 );
820
821 function Home() { ... }
822 function HomeError() { ... }
823 ```
824
825 - **Introducing Lazy Route Modules!** ([#10045](https://github.com/remix-run/react-router/pull/10045))
826
827 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`).
828
829 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.
830
831 Your `lazy` functions will typically return the result of a dynamic import.
832
833 ```jsx
834 // In this example, we assume most folks land on the homepage so we include that
835 // in our critical-path bundle, but then we lazily load modules for /a and /b so
836 // they don't load until the user navigates to those routes
837 let routes = createRoutesFromElements(
838 <Route path="/" element={<Layout />}>
839 <Route index element={<Home />} />
840 <Route path="a" lazy={() => import("./a")} />
841 <Route path="b" lazy={() => import("./b")} />
842 </Route>
843 );
844 ```
845
846 Then in your lazy route modules, export the properties you want defined for the route:
847
848 ```jsx
849 export async function loader({ request }) {
850 let data = await fetchData(request);
851 return json(data);
852 }
853
854 // Export a `Component` directly instead of needing to create a React Element from it
855 export function Component() {
856 let data = useLoaderData();
857
858 return (
859 <>
860 <h1>You made it!</h1>
861 <p>{data}</p>
862 </>
863 );
864 }
865
866 // Export an `ErrorBoundary` directly instead of needing to create a React Element from it
867 export function ErrorBoundary() {
868 let error = useRouteError();
869 return isRouteErrorResponse(error) ? (
870 <h1>
871 {error.status} {error.statusText}
872 </h1>
873 ) : (
874 <h1>{error.message || error}</h1>
875 );
876 }
877 ```
878
879 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.
880
881 🙌 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).
882
883 - Updated dependencies:
884 - `@remix-run/router@1.4.0`
885
886 ### Patch Changes
887
888 - Fix `generatePath` incorrectly applying parameters in some cases ([#10078](https://github.com/remix-run/react-router/pull/10078))
889 - Improve memoization for context providers to avoid unnecessary re-renders ([#9983](https://github.com/remix-run/react-router/pull/9983))
890
891 ## 6.8.2
892
893 ### Patch Changes
894
895 - Updated dependencies:
896 - `@remix-run/router@1.3.3`
897
898 ## 6.8.1
899
900 ### Patch Changes
901
902 - Remove inaccurate console warning for POP navigations and update active blocker logic ([#10030](https://github.com/remix-run/react-router/pull/10030))
903 - Updated dependencies:
904 - `@remix-run/router@1.3.2`
905
906 ## 6.8.0
907
908 ### Patch Changes
909
910 - Updated dependencies:
911 - `@remix-run/router@1.3.1`
912
913 ## 6.7.0
914
915 ### Minor Changes
916
917 - Add `unstable_useBlocker` hook for blocking navigations within the app's location origin ([#9709](https://github.com/remix-run/react-router/pull/9709))
918
919 ### Patch Changes
920
921 - Fix `generatePath` when optional params are present ([#9764](https://github.com/remix-run/react-router/pull/9764))
922 - Update `<Await>` to accept `ReactNode` as children function return result ([#9896](https://github.com/remix-run/react-router/pull/9896))
923 - Updated dependencies:
924 - `@remix-run/router@1.3.0`
925
926 ## 6.6.2
927
928 ### Patch Changes
929
930 - Ensure `useId` consistency during SSR ([#9805](https://github.com/remix-run/react-router/pull/9805))
931
932 ## 6.6.1
933
934 ### Patch Changes
935
936 - Updated dependencies:
937 - `@remix-run/router@1.2.1`
938
939 ## 6.6.0
940
941 ### Patch Changes
942
943 - Prevent `useLoaderData` usage in `errorElement` ([#9735](https://github.com/remix-run/react-router/pull/9735))
944 - Updated dependencies:
945 - `@remix-run/router@1.2.0`
946
947 ## 6.5.0
948
949 This 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.
950
951 **Optional Params Examples**
952
953 - `<Route path=":lang?/about>` will match:
954 - `/:lang/about`
955 - `/about`
956 - `<Route path="/multistep/:widget1?/widget2?/widget3?">` will match:
957 - `/multistep`
958 - `/multistep/:widget1`
959 - `/multistep/:widget1/:widget2`
960 - `/multistep/:widget1/:widget2/:widget3`
961
962 **Optional Static Segment Example**
963
964 - `<Route path="/home?">` will match:
965 - `/`
966 - `/home`
967 - `<Route path="/fr?/about">` will match:
968 - `/about`
969 - `/fr/about`
970
971 ### Minor Changes
972
973 - Allows optional routes and optional static segments ([#9650](https://github.com/remix-run/react-router/pull/9650))
974
975 ### Patch Changes
976
977 - 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))
978
979 ```jsx
980 // Old behavior at URL /prefix-123
981 }>
982
983 function Comp() {
984 let params = useParams(); // { id: '123' }
985 let id = params.id; // "123"
986 ...
987 }
988
989 // New behavior at URL /prefix-123
990 }>
991
992 function Comp() {
993 let params = useParams(); // { id: 'prefix-123' }
994 let id = params.id.replace(/^prefix-/, ''); // "123"
995 ...
996 }
997 ```
998
999 - Updated dependencies:
1000 - `@remix-run/router@1.1.0`
1001
1002 ## 6.4.5
1003
1004 ### Patch Changes
1005
1006 - Updated dependencies:
1007 - `@remix-run/router@1.0.5`
1008
1009 ## 6.4.4
1010
1011 ### Patch Changes
1012
1013 - Updated dependencies:
1014 - `@remix-run/router@1.0.4`
1015
1016 ## 6.4.3
1017
1018 ### Patch Changes
1019
1020 - `useRoutes` should be able to return `null` when passing `locationArg` ([#9485](https://github.com/remix-run/react-router/pull/9485))
1021 - fix `initialEntries` type in `createMemoryRouter` ([#9498](https://github.com/remix-run/react-router/pull/9498))
1022 - Updated dependencies:
1023 - `@remix-run/router@1.0.3`
1024
1025 ## 6.4.2
1026
1027 ### Patch Changes
1028
1029 - Fix `IndexRouteObject` and `NonIndexRouteObject` types to make `hasErrorElement` optional ([#9394](https://github.com/remix-run/react-router/pull/9394))
1030 - Enhance console error messages for invalid usage of data router hooks ([#9311](https://github.com/remix-run/react-router/pull/9311))
1031 - 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))
1032 - Updated dependencies:
1033 - `@remix-run/router@1.0.2`
1034
1035 ## 6.4.1
1036
1037 ### Patch Changes
1038
1039 - Preserve state from `initialEntries` ([#9288](https://github.com/remix-run/react-router/pull/9288))
1040 - Updated dependencies:
1041 - `@remix-run/router@1.0.1`
1042
1043 ## 6.4.0
1044
1045 Whoa 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/en/6.4.0/start/overview) and the [tutorial](https://reactrouter.com/en/6.4.0/start/tutorial).
1046
1047 **New APIs**
1048
1049 - Create your router with `createMemoryRouter`
1050 - Render your router with `<RouterProvider>`
1051 - Load data with a Route `loader` and mutate with a Route `action`
1052 - Handle errors with Route `errorElement`
1053 - Defer non-critical data with `defer` and `Await`
1054
1055 **Bug Fixes**
1056
1057 - Path resolution is now trailing slash agnostic (#8861)
1058 - `useLocation` returns the scoped location inside a `<Routes location>` component (#9094)
1059
1060 **Updated Dependencies**
1061
1062 - `@remix-run/router@1.0.0`