UNPKG

92.1 kBMarkdownView Raw
1# `react-router`
2
3## 7.8.0
4
5### Minor Changes
6
7- Add `nonce` prop to `Links` & `PrefetchPageLinks` ([#14048](https://github.com/remix-run/react-router/pull/14048))
8- Add `loaderData` arguments/properties alongside existing `data` arguments/properties to provide consistency and clarity between `loaderData` and `actionData` across the board ([#14047](https://github.com/remix-run/react-router/pull/14047))
9 - Updated types: `Route.MetaArgs`, `Route.MetaMatch`, `MetaArgs`, `MetaMatch`, `Route.ComponentProps.matches`, `UIMatch`
10 - `@deprecated` warnings have been added to the existing `data` properties to point users to new `loaderData` properties, in preparation for removing the `data` properties in a future major release
11
12### Patch Changes
13
14- Prevent _"Did not find corresponding fetcher result"_ console error when navigating during a `fetcher.submit` revalidation ([#14114](https://github.com/remix-run/react-router/pull/14114))
15
16- Bubble client-side middleware errors prior to `next` to the appropriate ancestor error boundary ([#14138](https://github.com/remix-run/react-router/pull/14138))
17
18- Switch Lazy Route Discovery manifest URL generation to usea standalone `URLSearchParams` instance instead of `URL.searchParams` to avoid a major performance bottleneck in Chrome ([#14084](https://github.com/remix-run/react-router/pull/14084))
19
20- Adjust internal RSC usage of `React.use` to avoid Webpack compilation errors when using React 18 ([#14113](https://github.com/remix-run/react-router/pull/14113))
21
22- Remove dependency on `@types/node` in TypeScript declaration files ([#14059](https://github.com/remix-run/react-router/pull/14059))
23
24- Fix types for `UIMatch` to reflect that the `loaderData`/`data` properties may be `undefined` ([#12206](https://github.com/remix-run/react-router/pull/12206))
25 - When an `ErrorBoundary` is being rendered, not all active matches will have loader data available, since it may have been their `loader` that threw to trigger the boundary
26 - The `UIMatch.data` type was not correctly handing this and would always reflect the presence of data, leading to the unexpected runtime errors when an `ErrorBoundary` was rendered
27 - ⚠️ This may cause some type errors to show up in your code for unguarded `match.data` accesses - you should properly guard for `undefined` values in those scenarios.
28
29 ```tsx
30 // app/root.tsx
31 export function loader() {
32 someFunctionThatThrows(); // ❌ Throws an Error
33 return { title: "My Title" };
34 }
35
36 export function Layout({ children }: { children: React.ReactNode }) {
37 let matches = useMatches();
38 let rootMatch = matches[0] as UIMatch<Awaited<ReturnType<typeof loader>>>;
39 // ^ rootMatch.data is incorrectly typed here, so TypeScript does not
40 // complain if you do the following which throws an error at runtime:
41 let { title } = rootMatch.data; // 💥
42
43 return <html>...</html>;
44 }
45 ```
46
47- \[UNSTABLE] Ensure resource route errors go through `handleError` w/middleware enabled ([#14078](https://github.com/remix-run/react-router/pull/14078))
48
49- \[UNSTABLE] Propagate returned Response from server middleware if next wasn't called ([#14093](https://github.com/remix-run/react-router/pull/14093))
50
51- \[UNSTABLE] Allow server middlewares to return `data()` values which will be converted into a `Response` ([#14093](https://github.com/remix-run/react-router/pull/14093))
52
53- \[UNSTABLE] Update middleware error handling so that the `next` function never throws and instead handles any middleware errors at the proper `ErrorBoundary` and returns the `Response` up through the ancestor `next` function ([#14118](https://github.com/remix-run/react-router/pull/14118))
54
55- \[UNSTABLE] When middleware is enabled, make the `context` parameter read-only (via `Readonly<unstable_RouterContextProvider>`) so that TypeScript will not allow you to write arbitrary fields to it in loaders, actions, or middleware. ([#14097](https://github.com/remix-run/react-router/pull/14097))
56
57- \[UNSTABLE] Rename and alter the signature/functionality of the `unstable_respond` API in `staticHandler.query`/`staticHandler.queryRoute` ([#14103](https://github.com/remix-run/react-router/pull/14103))
58 - The API has been renamed to `unstable_generateMiddlewareResponse` for clarity
59 - The main functional change is that instead of running the loaders/actions before calling `unstable_respond` and handing you the result, we now pass a `query`/`queryRoute` function as a parameter and you execute the loaders/actions inside your callback, giving you full access to pre-processing and error handling
60 - The `query` version of the API now has a signature of `(query: (r: Request) => Promise<StaticHandlerContext | Response>) => Promise<Response>`
61 - The `queryRoute` version of the API now has a signature of `(queryRoute: (r: Request) => Promise<Response>) => Promise<Response>`
62 - This allows for more advanced usages such as running logic before/after calling `query` and direct error handling of errors thrown from query
63 - ⚠️ This is a breaking change if you've adopted the `staticHandler` `unstable_respond` API
64
65 ```tsx
66 let response = await staticHandler.query(request, {
67 requestContext: new unstable_RouterContextProvider(),
68 async unstable_generateMiddlewareResponse(query) {
69 try {
70 // At this point we've run middleware top-down so we need to call the
71 // handlers and generate the Response to bubble back up the middleware
72 let result = await query(request);
73 if (isResponse(result)) {
74 return result; // Redirects, etc.
75 }
76 return await generateHtmlResponse(result);
77 } catch (error: unknown) {
78 return generateErrorResponse(error);
79 }
80 },
81 });
82 ```
83
84- \[UNSTABLE] Convert internal middleware implementations to use the new `unstable_generateMiddlewareResponse` API ([#14103](https://github.com/remix-run/react-router/pull/14103))
85
86- \[UNSTABLE] Change `getLoadContext` signature (`type GetLoadContextFunction`) when `future.unstable_middleware` is enabled so that it returns an `unstable_RouterContextProvider` instance instead of a `Map` used to contruct the instance internally ([#14097](https://github.com/remix-run/react-router/pull/14097))
87 - This also removes the `type unstable_InitialContext` export
88 - ⚠️ This is a breaking change if you have adopted middleware and are using a custom server with a `getLoadContext` function
89
90- \[UNSTABLE] Run client middleware on client navigations even if no loaders exist ([#14106](https://github.com/remix-run/react-router/pull/14106))
91
92- \[UNSTABLE] Change the `unstable_getContext` signature on `RouterProvider`/`HydratedRouter`/`unstable_RSCHydratedRouter` so that it returns an `unstable_RouterContextProvider` instance instead of a `Map` used to contruct the instance internally ([#14097](https://github.com/remix-run/react-router/pull/14097))
93 - ⚠️ This is a breaking change if you have adopted the `unstable_getContext` prop
94
95- [UNSTABLE] proxy server action side-effect redirects from actions for document and callServer requests ([#14131](https://github.com/remix-run/react-router/pull/14131))
96
97- [UNSTABLE] Fix RSC Data Mode issue where routes that return `false` from `shouldRevalidate` would be replaced by an `<Outlet />` ([#14071](https://github.com/remix-run/react-router/pull/14071))
98
99## 7.7.1
100
101### Patch Changes
102
103- In RSC Data Mode, fix bug where routes with errors weren't forced to revalidate when `shouldRevalidate` returned false ([#14026](https://github.com/remix-run/react-router/pull/14026))
104- In RSC Data Mode, fix `Matched leaf route at location "/..." does not have an element or Component` warnings when error boundaries are rendered. ([#14021](https://github.com/remix-run/react-router/pull/14021))
105
106## 7.7.0
107
108### Minor Changes
109
110- Add unstable RSC support ([#13700](https://github.com/remix-run/react-router/pull/13700))
111
112 For more information, see the [RSC documentation](https://reactrouter.com/start/rsc/installation).
113
114### Patch Changes
115
116- Handle `InvalidCharacterError` when validating cookie signature ([#13847](https://github.com/remix-run/react-router/pull/13847))
117
118- Pass a copy of `searchParams` to the `setSearchParams` callback function to avoid muations of the internal `searchParams` instance. This was an issue when navigations were blocked because the internal instance be out of sync with `useLocation().search`. ([#12784](https://github.com/remix-run/react-router/pull/12784))
119
120- Support invalid `Date` in `turbo-stream` v2 fork ([#13684](https://github.com/remix-run/react-router/pull/13684))
121
122- In Framework Mode, clear critical CSS in development after initial render ([#13872](https://github.com/remix-run/react-router/pull/13872))
123
124- Strip search parameters from `patchRoutesOnNavigation` `path` param for fetcher calls ([#13911](https://github.com/remix-run/react-router/pull/13911))
125
126- Skip scroll restoration on useRevalidator() calls because they're not new locations ([#13671](https://github.com/remix-run/react-router/pull/13671))
127
128- Support unencoded UTF-8 routes in prerender config with `ssr` set to `false` ([#13699](https://github.com/remix-run/react-router/pull/13699))
129
130- Do not throw if the url hash is not a valid URI component ([#13247](https://github.com/remix-run/react-router/pull/13247))
131
132- Fix a regression in `createRoutesStub` introduced with the middleware feature. ([#13946](https://github.com/remix-run/react-router/pull/13946))
133
134 As part of that work we altered the signature to align with the new middleware APIs without making it backwards compatible with the prior `AppLoadContext` API. This permitted `createRoutesStub` to work if you were opting into middleware and the updated `context` typings, but broke `createRoutesStub` for users not yet opting into middleware.
135
136 We've reverted this change and re-implemented it in such a way that both sets of users can leverage it.
137
138 ```tsx
139 // If you have not opted into middleware, the old API should work again
140 let context: AppLoadContext = {
141 /*...*/
142 };
143 let Stub = createRoutesStub(routes, context);
144
145 // If you have opted into middleware, you should now pass an instantiated `unstable_routerContextProvider` instead of a `getContext` factory function.
146 let context = new unstable_RouterContextProvider();
147 context.set(SomeContext, someValue);
148 let Stub = createRoutesStub(routes, context);
149 ```
150
151 ⚠️ This may be a breaking bug for if you have adopted the unstable Middleware feature and are using `createRoutesStub` with the updated API.
152
153- Remove `Content-Length` header from Single Fetch responses ([#13902](https://github.com/remix-run/react-router/pull/13902))
154
155## 7.6.3
156
157### Patch Changes
158
159- Do not serialize types for `useRouteLoaderData<typeof clientLoader>` ([#13752](https://github.com/remix-run/react-router/pull/13752))
160
161 For types to distinguish a `clientLoader` from a `serverLoader`, you MUST annotate `clientLoader` args:
162
163 ```ts
164 // 👇 annotation required to skip serializing types
165 export function clientLoader({}: Route.ClientLoaderArgs) {
166 return { fn: () => "earth" };
167 }
168
169 function SomeComponent() {
170 const data = useRouteLoaderData<typeof clientLoader>("routes/this-route");
171 const planet = data?.fn() ?? "world";
172 return <h1>Hello, {planet}!</h1>;
173 }
174 ```
175
176## 7.6.2
177
178### Patch Changes
179
180- Avoid additional `with-props` chunk in Framework Mode by moving route module component prop logic from the Vite plugin to `react-router` ([#13650](https://github.com/remix-run/react-router/pull/13650))
181- Slight refactor of internal `headers()` function processing for use with RSC ([#13639](https://github.com/remix-run/react-router/pull/13639))
182
183## 7.6.1
184
185### Patch Changes
186
187- Update `Route.MetaArgs` to reflect that `data` can be potentially `undefined` ([#13563](https://github.com/remix-run/react-router/pull/13563))
188
189 This is primarily for cases where a route `loader` threw an error to it's own `ErrorBoundary`. but it also arises in the case of a 404 which renders the root `ErrorBoundary`/`meta` but the root loader did not run because not routes matched.
190
191- Partially revert optimization added in `7.1.4` to reduce calls to `matchRoutes` because it surfaced other issues ([#13562](https://github.com/remix-run/react-router/pull/13562))
192
193- Fix typegen when same route is used at multiple paths ([#13574](https://github.com/remix-run/react-router/pull/13574))
194
195 For example, `routes/route.tsx` is used at 4 different paths here:
196
197 ```ts
198 import { type RouteConfig, route } from "@react-router/dev/routes";
199 export default [
200 route("base/:base", "routes/base.tsx", [
201 route("home/:home", "routes/route.tsx", { id: "home" }),
202 route("changelog/:changelog", "routes/route.tsx", { id: "changelog" }),
203 route("splat/*", "routes/route.tsx", { id: "splat" }),
204 ]),
205 route("other/:other", "routes/route.tsx", { id: "other" }),
206 ] satisfies RouteConfig;
207 ```
208
209 Previously, typegen would arbitrarily pick one of these paths to be the "winner" and generate types for the route module based on that path.
210 Now, typegen creates unions as necessary for alternate paths for the same route file.
211
212- Better types for `params` ([#13543](https://github.com/remix-run/react-router/pull/13543))
213
214 For example:
215
216 ```ts
217 // routes.ts
218 import { type RouteConfig, route } from "@react-router/dev/routes";
219
220 export default [
221 route("parent/:p", "routes/parent.tsx", [
222 route("layout/:l", "routes/layout.tsx", [
223 route("child1/:c1a/:c1b", "routes/child1.tsx"),
224 route("child2/:c2a/:c2b", "routes/child2.tsx"),
225 ]),
226 ]),
227 ] satisfies RouteConfig;
228 ```
229
230 Previously, `params` for the `routes/layout.tsx` route were calculated as `{ p: string, l: string }`.
231 This incorrectly ignores params that could come from child routes.
232 If visiting `/parent/1/layout/2/child1/3/4`, the actual params passed to `routes/layout.tsx` will have a type of `{ p: string, l: string, c1a: string, c1b: string }`.
233
234 Now, `params` are aware of child routes and autocompletion will include child params as optionals:
235
236 ```ts
237 params.|
238 // ^ cursor is here and you ask for autocompletion
239 // p: string
240 // l: string
241 // c1a?: string
242 // c1b?: string
243 // c2a?: string
244 // c2b?: string
245 ```
246
247 You can also narrow the types for `params` as it is implemented as a normalized union of params for each page that includes `routes/layout.tsx`:
248
249 ```ts
250 if (typeof params.c1a === 'string') {
251 params.|
252 // ^ cursor is here and you ask for autocompletion
253 // p: string
254 // l: string
255 // c1a: string
256 // c1b: string
257 }
258 ```
259
260 ***
261
262 UNSTABLE: renamed internal `react-router/route-module` export to `react-router/internal`
263 UNSTABLE: removed `Info` export from generated `+types/*` files
264
265- Avoid initial fetcher execution 404 error when Lazy Route Discovery is interrupted by a navigation ([#13564](https://github.com/remix-run/react-router/pull/13564))
266
267- href replaces splats `*` ([#13593](https://github.com/remix-run/react-router/pull/13593))
268
269 ```ts
270 const a = href("/products/*", { "*": "/1/edit" });
271 // -> /products/1/edit
272 ```
273
274## 7.6.0
275
276### Minor Changes
277
278- Added a new `react-router.config.ts` `routeDiscovery` option to configure Lazy Route Discovery behavior. ([#13451](https://github.com/remix-run/react-router/pull/13451))
279 - By default, Lazy Route Discovery is enabled and makes manifest requests to the `/__manifest` path:
280 - `routeDiscovery: { mode: "lazy", manifestPath: "/__manifest" }`
281 - You can modify the manifest path used:
282 - `routeDiscovery: { mode: "lazy", manifestPath: "/custom-manifest" }`
283 - Or you can disable this feature entirely and include all routes in the manifest on initial document load:
284 - `routeDiscovery: { mode: "initial" }`
285
286- Add support for route component props in `createRoutesStub`. This allows you to unit test your route components using the props instead of the hooks: ([#13528](https://github.com/remix-run/react-router/pull/13528))
287
288 ```tsx
289 let RoutesStub = createRoutesStub([
290 {
291 path: "/",
292 Component({ loaderData }) {
293 let data = loaderData as { message: string };
294 return <pre data-testid="data">Message: {data.message}</pre>;
295 },
296 loader() {
297 return { message: "hello" };
298 },
299 },
300 ]);
301
302 render(<RoutesStub />);
303
304 await waitFor(() => screen.findByText("Message: hello"));
305 ```
306
307### Patch Changes
308
309- Fix `react-router` module augmentation for `NodeNext` ([#13498](https://github.com/remix-run/react-router/pull/13498))
310
311- Don't bundle `react-router` in `react-router/dom` CJS export ([#13497](https://github.com/remix-run/react-router/pull/13497))
312
313- Fix bug where a submitting `fetcher` would get stuck in a `loading` state if a revalidating `loader` redirected ([#12873](https://github.com/remix-run/react-router/pull/12873))
314
315- Fix hydration error if a server `loader` returned `undefined` ([#13496](https://github.com/remix-run/react-router/pull/13496))
316
317- Fix initial load 404 scenarios in data mode ([#13500](https://github.com/remix-run/react-router/pull/13500))
318
319- Stabilize `useRevalidator`'s `revalidate` function ([#13542](https://github.com/remix-run/react-router/pull/13542))
320
321- Preserve status code if a `clientAction` throws a `data()` result in framework mode ([#13522](https://github.com/remix-run/react-router/pull/13522))
322
323- Be defensive against leading double slashes in paths to avoid `Invalid URL` errors from the URL constructor ([#13510](https://github.com/remix-run/react-router/pull/13510))
324 - Note we do not sanitize/normalize these paths - we only detect them so we can avoid the error that would be thrown by `new URL("//", window.location.origin)`
325
326- Remove `Navigator` declaration for `navigator.connection.saveData` to avoid messing with any other types beyond `saveData` in userland ([#13512](https://github.com/remix-run/react-router/pull/13512))
327
328- Fix `handleError` `params` values on `.data` requests for routes with a dynamic param as the last URL segment ([#13481](https://github.com/remix-run/react-router/pull/13481))
329
330- Don't trigger an `ErrorBoundary` UI before the reload when we detect a manifest verison mismatch in Lazy Route Discovery ([#13480](https://github.com/remix-run/react-router/pull/13480))
331
332- Inline `turbo-stream@2.4.1` dependency and fix decoding ordering of Map/Set instances ([#13518](https://github.com/remix-run/react-router/pull/13518))
333
334- Only render dev warnings in DEV mode ([#13461](https://github.com/remix-run/react-router/pull/13461))
335
336- UNSTABLE: Fix a few bugs with error bubbling in middleware use-cases ([#13538](https://github.com/remix-run/react-router/pull/13538))
337
338- Short circuit post-processing on aborted `dataStrategy` requests ([#13521](https://github.com/remix-run/react-router/pull/13521))
339 - This resolves non-user-facing console errors of the form `Cannot read properties of undefined (reading 'result')`
340
341## 7.5.3
342
343### Patch Changes
344
345- Fix bug where bubbled action errors would result in `loaderData` being cleared at the handling `ErrorBoundary` route ([#13476](https://github.com/remix-run/react-router/pull/13476))
346- Handle redirects from `clientLoader.hydrate` initial load executions ([#13477](https://github.com/remix-run/react-router/pull/13477))
347
348## 7.5.2
349
350### Patch Changes
351
352- Update Single Fetch to also handle the 204 redirects used in `?_data` requests in Remix v2 ([#13364](https://github.com/remix-run/react-router/pull/13364))
353 - This allows applications to return a redirect on `.data` requests from outside the scope of React Router (i.e., an `express`/`hono` middleware)
354 - ⚠️ Please note that doing so relies on implementation details that are subject to change without a SemVer major release
355 - This is primarily done to ease upgrading to Single Fetch for existing Remix v2 applications, but the recommended way to handle this is redirecting from a route middleware
356
357- Adjust approach for Prerendering/SPA Mode via headers ([#13453](https://github.com/remix-run/react-router/pull/13453))
358
359## 7.5.1
360
361### Patch Changes
362
363- Fix single fetch bug where no revalidation request would be made when navigating upwards to a reused parent route ([#13253](https://github.com/remix-run/react-router/pull/13253))
364
365- When using the object-based `route.lazy` API, the `HydrateFallback` and `hydrateFallbackElement` properties are now skipped when lazy loading routes after hydration. ([#13376](https://github.com/remix-run/react-router/pull/13376))
366
367 If you move the code for these properties into a separate file, you can use this optimization to avoid downloading unused hydration code. For example:
368
369 ```ts
370 createBrowserRouter([
371 {
372 path: "/show/:showId",
373 lazy: {
374 loader: async () => (await import("./show.loader.js")).loader,
375 Component: async () => (await import("./show.component.js")).Component,
376 HydrateFallback: async () =>
377 (await import("./show.hydrate-fallback.js")).HydrateFallback,
378 },
379 },
380 ]);
381 ```
382
383- Properly revalidate prerendered paths when param values change ([#13380](https://github.com/remix-run/react-router/pull/13380))
384
385- UNSTABLE: Add a new `unstable_runClientMiddleware` argument to `dataStrategy` to enable middleware execution in custom `dataStrategy` implementations ([#13395](https://github.com/remix-run/react-router/pull/13395))
386
387- UNSTABLE: Add better error messaging when `getLoadContext` is not updated to return a `Map`" ([#13242](https://github.com/remix-run/react-router/pull/13242))
388
389- Do not automatically add `null` to `staticHandler.query()` `context.loaderData` if routes do not have loaders ([#13223](https://github.com/remix-run/react-router/pull/13223))
390 - This was a Remix v2 implementation detail inadvertently left in for React Router v7
391 - Now that we allow returning `undefined` from loaders, our prior check of `loaderData[routeId] !== undefined` was no longer sufficient and was changed to a `routeId in loaderData` check - these `null` values can cause issues for this new check
392 - ⚠️ This could be a "breaking bug fix" for you if you are doing manual SSR with `createStaticHandler()`/`<StaticRouterProvider>`, and using `context.loaderData` to control `<RouterProvider>` hydration behavior on the client
393
394- Fix prerendering when a loader returns a redirect ([#13365](https://github.com/remix-run/react-router/pull/13365))
395
396- UNSTABLE: Update context type for `LoaderFunctionArgs`/`ActionFunctionArgs` when middleware is enabled ([#13381](https://github.com/remix-run/react-router/pull/13381))
397
398- Add support for the new `unstable_shouldCallHandler`/`unstable_shouldRevalidateArgs` APIs in `dataStrategy` ([#13253](https://github.com/remix-run/react-router/pull/13253))
399
400## 7.5.0
401
402### Minor Changes
403
404- Add granular object-based API for `route.lazy` to support lazy loading of individual route properties, for example: ([#13294](https://github.com/remix-run/react-router/pull/13294))
405
406 ```ts
407 createBrowserRouter([
408 {
409 path: "/show/:showId",
410 lazy: {
411 loader: async () => (await import("./show.loader.js")).loader,
412 action: async () => (await import("./show.action.js")).action,
413 Component: async () => (await import("./show.component.js")).Component,
414 },
415 },
416 ]);
417 ```
418
419 **Breaking change for `route.unstable_lazyMiddleware` consumers**
420
421 The `route.unstable_lazyMiddleware` property is no longer supported. If you want to lazily load middleware, you must use the new object-based `route.lazy` API with `route.lazy.unstable_middleware`, for example:
422
423 ```ts
424 createBrowserRouter([
425 {
426 path: "/show/:showId",
427 lazy: {
428 unstable_middleware: async () =>
429 (await import("./show.middleware.js")).middleware,
430 // etc.
431 },
432 },
433 ]);
434 ```
435
436### Patch Changes
437
438- Introduce `unstable_subResourceIntegrity` future flag that enables generation of an importmap with integrity for the scripts that will be loaded by the browser. ([#13163](https://github.com/remix-run/react-router/pull/13163))
439
440## 7.4.1
441
442### Patch Changes
443
444- Fix types on `unstable_MiddlewareFunction` to avoid type errors when a middleware doesn't return a value ([#13311](https://github.com/remix-run/react-router/pull/13311))
445- Dedupe calls to `route.lazy` functions ([#13260](https://github.com/remix-run/react-router/pull/13260))
446- Add support for `route.unstable_lazyMiddleware` function to allow lazy loading of middleware logic. ([#13210](https://github.com/remix-run/react-router/pull/13210))
447
448 **Breaking change for `unstable_middleware` consumers**
449
450 The `route.unstable_middleware` property is no longer supported in the return value from `route.lazy`. If you want to lazily load middleware, you must use `route.unstable_lazyMiddleware`.
451
452## 7.4.0
453
454### Patch Changes
455
456- Fix root loader data on initial load redirects in SPA mode ([#13222](https://github.com/remix-run/react-router/pull/13222))
457- Load ancestor pathless/index routes in lazy route discovery for upwards non-eager-discoery routing ([#13203](https://github.com/remix-run/react-router/pull/13203))
458- Fix `shouldRevalidate` behavior for `clientLoader`-only routes in `ssr:true` apps ([#13221](https://github.com/remix-run/react-router/pull/13221))
459- UNSTABLE: Fix `RequestHandler` `loadContext` parameter type when middleware is enabled ([#13204](https://github.com/remix-run/react-router/pull/13204))
460- UNSTABLE: Update `Route.unstable_MiddlewareFunction` to have a return value of `Response | undefined` instead of `Response | void` becaue you should not return anything if you aren't returning the `Response` ([#13199](https://github.com/remix-run/react-router/pull/13199))
461- UNSTABLE(BREAKING): If a middleware throws an error, ensure we only bubble the error itself via `next()` and are no longer leaking the `MiddlewareError` implementation detail ([#13180](https://github.com/remix-run/react-router/pull/13180))
462
463## 7.3.0
464
465### Minor Changes
466
467- Add `fetcherKey` as a parameter to `patchRoutesOnNavigation` ([#13061](https://github.com/remix-run/react-router/pull/13061))
468 - In framework mode, Lazy Route Discovery will now detect manifest version mismatches after a new deploy
469 - On navigations to undiscovered routes, this mismatch will trigger a document reload of the destination path
470 - On `fetcher` calls to undiscovered routes, this mismatch will trigger a document reload of the current path
471
472### Patch Changes
473
474- Skip resource route flow in dev server in SPA mode ([#13113](https://github.com/remix-run/react-router/pull/13113))
475
476- Support middleware on routes (unstable) ([#12941](https://github.com/remix-run/react-router/pull/12941))
477
478 Middleware is implemented behind a `future.unstable_middleware` flag. To enable, you must enable the flag and the types in your `react-router-config.ts` file:
479
480 ```ts
481 import type { Config } from "@react-router/dev/config";
482 import type { Future } from "react-router";
483
484 declare module "react-router" {
485 interface Future {
486 unstable_middleware: true; // 👈 Enable middleware types
487 }
488 }
489
490 export default {
491 future: {
492 unstable_middleware: true, // 👈 Enable middleware
493 },
494 } satisfies Config;
495 ```
496
497 ⚠️ Middleware is unstable and should not be adopted in production. There is at least one known de-optimization in route module loading for `clientMiddleware` that we will be addressing this before a stable release.
498
499 ⚠️ Enabling middleware contains a breaking change to the `context` parameter passed to your `loader`/`action` functions - see below for more information.
500
501 Once enabled, routes can define an array of middleware functions that will run sequentially before route handlers run. These functions accept the same parameters as `loader`/`action` plus an additional `next` parameter to run the remaining data pipeline. This allows middlewares to perform logic before and after handlers execute.
502
503 ```tsx
504 // Framework mode
505 export const unstable_middleware = [serverLogger, serverAuth]; // server
506 export const unstable_clientMiddleware = [clientLogger]; // client
507
508 // Library mode
509 const routes = [
510 {
511 path: "/",
512 // Middlewares are client-side for library mode SPA's
513 unstable_middleware: [clientLogger, clientAuth],
514 loader: rootLoader,
515 Component: Root,
516 },
517 ];
518 ```
519
520 Here's a simple example of a client-side logging middleware that can be placed on the root route:
521
522 ```tsx
523 const clientLogger: Route.unstable_ClientMiddlewareFunction = async (
524 { request },
525 next,
526 ) => {
527 let start = performance.now();
528
529 // Run the remaining middlewares and all route loaders
530 await next();
531
532 let duration = performance.now() - start;
533 console.log(`Navigated to ${request.url} (${duration}ms)`);
534 };
535 ```
536
537 Note that in the above example, the `next`/`middleware` functions don't return anything. This is by design as on the client there is no "response" to send over the network like there would be for middlewares running on the server. The data is all handled behind the scenes by the stateful `router`.
538
539 For a server-side middleware, the `next` function will return the HTTP `Response` that React Router will be sending across the wire, thus giving you a chance to make changes as needed. You may throw a new response to short circuit and respond immediately, or you may return a new or altered response to override the default returned by `next()`.
540
541 ```tsx
542 const serverLogger: Route.unstable_MiddlewareFunction = async (
543 { request, params, context },
544 next,
545 ) => {
546 let start = performance.now();
547
548 // 👇 Grab the response here
549 let res = await next();
550
551 let duration = performance.now() - start;
552 console.log(`Navigated to ${request.url} (${duration}ms)`);
553
554 // 👇 And return it here (optional if you don't modify the response)
555 return res;
556 };
557 ```
558
559 You can throw a `redirect` from a middleware to short circuit any remaining processing:
560
561 ```tsx
562 import { sessionContext } from "../context";
563 const serverAuth: Route.unstable_MiddlewareFunction = (
564 { request, params, context },
565 next,
566 ) => {
567 let session = context.get(sessionContext);
568 let user = session.get("user");
569 if (!user) {
570 session.set("returnTo", request.url);
571 throw redirect("/login", 302);
572 }
573 };
574 ```
575
576 _Note that in cases like this where you don't need to do any post-processing you don't need to call the `next` function or return a `Response`._
577
578 Here's another example of using a server middleware to detect 404s and check the CMS for a redirect:
579
580 ```tsx
581 const redirects: Route.unstable_MiddlewareFunction = async ({
582 request,
583 next,
584 }) => {
585 // attempt to handle the request
586 let res = await next();
587
588 // if it's a 404, check the CMS for a redirect, do it last
589 // because it's expensive
590 if (res.status === 404) {
591 let cmsRedirect = await checkCMSRedirects(request.url);
592 if (cmsRedirect) {
593 throw redirect(cmsRedirect, 302);
594 }
595 }
596
597 return res;
598 };
599 ```
600
601 **`context` parameter**
602
603 When middleware is enabled, your application will use a different type of `context` parameter in your loaders and actions to provide better type safety. Instead of `AppLoadContext`, `context` will now be an instance of `ContextProvider` that you can use with type-safe contexts (similar to `React.createContext`):
604
605 ```ts
606 import { unstable_createContext } from "react-router";
607 import { Route } from "./+types/root";
608 import type { Session } from "./sessions.server";
609 import { getSession } from "./sessions.server";
610
611 let sessionContext = unstable_createContext<Session>();
612
613 const sessionMiddleware: Route.unstable_MiddlewareFunction = ({
614 context,
615 request,
616 }) => {
617 let session = await getSession(request);
618 context.set(sessionContext, session);
619 // ^ must be of type Session
620 };
621
622 // ... then in some downstream middleware
623 const loggerMiddleware: Route.unstable_MiddlewareFunction = ({
624 context,
625 request,
626 }) => {
627 let session = context.get(sessionContext);
628 // ^ typeof Session
629 console.log(session.get("userId"), request.method, request.url);
630 };
631
632 // ... or some downstream loader
633 export function loader({ context }: Route.LoaderArgs) {
634 let session = context.get(sessionContext);
635 let profile = await getProfile(session.get("userId"));
636 return { profile };
637 }
638 ```
639
640 If you are using a custom server with a `getLoadContext` function, the return value for initial context values passed from the server adapter layer is no longer an object and should now return an `unstable_InitialContext` (`Map<RouterContext, unknown>`):
641
642 ```ts
643 let adapterContext = unstable_createContext<MyAdapterContext>();
644
645 function getLoadContext(req, res): unstable_InitialContext {
646 let map = new Map();
647 map.set(adapterContext, getAdapterContext(req));
648 return map;
649 }
650 ```
651
652- Fix types for loaderData and actionData that contained `Record`s ([#13139](https://github.com/remix-run/react-router/pull/13139))
653
654 UNSTABLE(BREAKING):
655
656 `unstable_SerializesTo` added a way to register custom serialization types in Single Fetch for other library and framework authors like Apollo.
657 It was implemented with branded type whose branded property that was made optional so that casting arbitrary values was easy:
658
659 ```ts
660 // without the brand being marked as optional
661 let x1 = 42 as unknown as unstable_SerializesTo<number>;
662 // ^^^^^^^^^^
663
664 // with the brand being marked as optional
665 let x2 = 42 as unstable_SerializesTo<number>;
666 ```
667
668 However, this broke type inference in `loaderData` and `actionData` for any `Record` types as those would now (incorrectly) match `unstable_SerializesTo`.
669 This affected all users, not just those that depended on `unstable_SerializesTo`.
670 To fix this, the branded property of `unstable_SerializesTo` is marked as required instead of optional.
671
672 For library and framework authors using `unstable_SerializesTo`, you may need to add `as unknown` casts before casting to `unstable_SerializesTo`.
673
674- Fix single fetch `_root.data` requests when a `basename` is used ([#12898](https://github.com/remix-run/react-router/pull/12898))
675
676- Add `context` support to client side data routers (unstable) ([#12941](https://github.com/remix-run/react-router/pull/12941))
677
678 Your application `loader` and `action` functions on the client will now receive a `context` parameter. This is an instance of `unstable_RouterContextProvider` that you use with type-safe contexts (similar to `React.createContext`) and is most useful with the corresponding `middleware`/`clientMiddleware` API's:
679
680 ```ts
681 import { unstable_createContext } from "react-router";
682
683 type User = {
684 /*...*/
685 };
686
687 let userContext = unstable_createContext<User>();
688
689 function sessionMiddleware({ context }) {
690 let user = await getUser();
691 context.set(userContext, user);
692 }
693
694 // ... then in some downstream loader
695 function loader({ context }) {
696 let user = context.get(userContext);
697 let profile = await getProfile(user.id);
698 return { profile };
699 }
700 ```
701
702 Similar to server-side requests, a fresh `context` will be created per navigation (or `fetcher` call). If you have initial data you'd like to populate in the context for every request, you can provide an `unstable_getContext` function at the root of your app:
703 - Library mode - `createBrowserRouter(routes, { unstable_getContext })`
704 - Framework mode - `<HydratedRouter unstable_getContext>`
705
706 This function should return an value of type `unstable_InitialContext` which is a `Map<unstable_RouterContext, unknown>` of context's and initial values:
707
708 ```ts
709 const loggerContext = unstable_createContext<(...args: unknown[]) => void>();
710
711 function logger(...args: unknown[]) {
712 console.log(new Date.toISOString(), ...args);
713 }
714
715 function unstable_getContext() {
716 let map = new Map();
717 map.set(loggerContext, logger);
718 return map;
719 }
720 ```
721
722## 7.2.0
723
724### Minor Changes
725
726- New type-safe `href` utility that guarantees links point to actual paths in your app ([#13012](https://github.com/remix-run/react-router/pull/13012))
727
728 ```tsx
729 import { href } from "react-router";
730
731 export default function Component() {
732 const link = href("/blog/:slug", { slug: "my-first-post" });
733 return (
734 <main>
735 <Link to={href("/products/:id", { id: "asdf" })} />
736 <NavLink to={href("/:lang?/about", { lang: "en" })} />
737 </main>
738 );
739 }
740 ```
741
742### Patch Changes
743
744- Fix typegen for repeated params ([#13012](https://github.com/remix-run/react-router/pull/13012))
745
746 In React Router, path parameters are keyed by their name.
747 So for a path pattern like `/a/:id/b/:id?/c/:id`, the last `:id` will set the value for `id` in `useParams` and the `params` prop.
748 For example, `/a/1/b/2/c/3` will result in the value `{ id: 3 }` at runtime.
749
750 Previously, generated types for params incorrectly modeled repeated params with an array.
751 So `/a/1/b/2/c/3` generated a type like `{ id: [1,2,3] }`.
752
753 To be consistent with runtime behavior, the generated types now correctly model the "last one wins" semantics of path parameters.
754 So `/a/1/b/2/c/3` now generates a type like `{ id: 3 }`.
755
756- Don't apply Single Fetch revalidation de-optimization when in SPA mode since there is no server HTTP request ([#12948](https://github.com/remix-run/react-router/pull/12948))
757
758- Properly handle revalidations to across a prerender/SPA boundary ([#13021](https://github.com/remix-run/react-router/pull/13021))
759 - In "hybrid" applications where some routes are pre-rendered and some are served from a SPA fallback, we need to avoid making `.data` requests if the path wasn't pre-rendered because the request will 404
760 - We don't know all the pre-rendered paths client-side, however:
761 - All `loader` data in `ssr:false` mode is static because it's generated at build time
762 - A route must use a `clientLoader` to do anything dynamic
763 - Therefore, if a route only has a `loader` and not a `clientLoader`, we disable revalidation by default because there is no new data to retrieve
764 - We short circuit and skip single fetch `.data` request logic if there are no server loaders with `shouldLoad=true` in our single fetch `dataStrategy`
765 - This ensures that the route doesn't cause a `.data` request that would 404 after a submission
766
767- Error at build time in `ssr:false` + `prerender` apps for the edge case scenario of: ([#13021](https://github.com/remix-run/react-router/pull/13021))
768 - A parent route has only a `loader` (does not have a `clientLoader`)
769 - The parent route is pre-rendered
770 - The parent route has children routes which are not prerendered
771 - This means that when the child paths are loaded via the SPA fallback, the parent won't have any `loaderData` because there is no server on which to run the `loader`
772 - This can be resolved by either adding a parent `clientLoader` or pre-rendering the child paths
773 - If you add a `clientLoader`, calling the `serverLoader()` on non-prerendered paths will throw a 404
774
775- Add unstable support for splitting route modules in framework mode via `future.unstable_splitRouteModules` ([#11871](https://github.com/remix-run/react-router/pull/11871))
776
777- Add `unstable_SerializesTo` brand type for library authors to register types serializable by React Router's streaming format (`turbo-stream`) ([`ab5b05b02`](https://github.com/remix-run/react-router/commit/ab5b05b02f99f062edb3c536c392197c88eb6c77))
778
779- Align dev server behavior with static file server behavior when `ssr:false` is set ([#12948](https://github.com/remix-run/react-router/pull/12948))
780 - When no `prerender` config exists, only SSR down to the root `HydrateFallback` (SPA Mode)
781 - When a `prerender` config exists but the current path is not prerendered, only SSR down to the root `HydrateFallback` (SPA Fallback)
782 - Return a 404 on `.data` requests to non-pre-rendered paths
783
784- Improve prefetch performance of CSS side effects in framework mode ([#12889](https://github.com/remix-run/react-router/pull/12889))
785
786- Disable Lazy Route Discovery for all `ssr:false` apps and not just "SPA Mode" because there is no runtime server to serve the search-param-configured `__manifest` requests ([#12894](https://github.com/remix-run/react-router/pull/12894))
787 - We previously only disabled this for "SPA Mode" which is `ssr:false` and no `prerender` config but we realized it should apply to all `ssr:false` apps, including those prerendering multiple pages
788 - In those `prerender` scenarios we would prerender the `/__manifest` file assuming the static file server would serve it but that makes some unneccesary assumptions about the static file server behaviors
789
790- Properly handle interrupted manifest requests in lazy route discovery ([#12915](https://github.com/remix-run/react-router/pull/12915))
791
792## 7.1.5
793
794### Patch Changes
795
796- Fix regression introduced in `7.1.4` via [#12800](https://github.com/remix-run/react-router/pull/12800) that caused issues navigating to hash routes inside splat routes for applications using Lazy Route Discovery (`patchRoutesOnNavigation`) ([#12927](https://github.com/remix-run/react-router/pull/12927))
797
798## 7.1.4
799
800### Patch Changes
801
802- Internal reorg to clean up some duplicated route module types ([#12799](https://github.com/remix-run/react-router/pull/12799))
803- Properly handle status codes that cannot have a body in single fetch responses (204, etc.) ([#12760](https://github.com/remix-run/react-router/pull/12760))
804- Stop erroring on resource routes that return raw strings/objects and instead serialize them as `text/plain` or `application/json` responses ([#12848](https://github.com/remix-run/react-router/pull/12848))
805 - This only applies when accessed as a resource route without the `.data` extension
806 - When accessed from a Single Fetch `.data` request, they will still be encoded via `turbo-stream`
807- Optimize Lazy Route Discovery path discovery to favor a single `querySelectorAll` call at the `body` level instead of many calls at the sub-tree level ([#12731](https://github.com/remix-run/react-router/pull/12731))
808- Properly bubble headers as `errorHeaders` when throwing a `data()` result ([#12846](https://github.com/remix-run/react-router/pull/12846))
809 - Avoid duplication of `Set-Cookie` headers could be duplicated if also returned from `headers`
810- Optimize route matching by skipping redundant `matchRoutes` calls when possible ([#12800](https://github.com/remix-run/react-router/pull/12800))
811
812## 7.1.3
813
814_No changes_
815
816## 7.1.2
817
818### Patch Changes
819
820- Fix issue with fetcher data cleanup in the data layer on fetcher unmount ([#12681](https://github.com/remix-run/react-router/pull/12681))
821- Do not rely on `symbol` for filtering out `redirect` responses from loader data ([#12694](https://github.com/remix-run/react-router/pull/12694))
822
823 Previously, some projects were getting type checking errors like:
824
825 ```ts
826 error TS4058: Return type of exported function has or is using name 'redirectSymbol' from external module "node_modules/..." but cannot be named.
827 ```
828
829 Now that `symbol`s are not used for the `redirect` response type, these errors should no longer be present.
830
831## 7.1.1
832
833_No changes_
834
835## 7.1.0
836
837### Patch Changes
838
839- Throw unwrapped single fetch redirect to align with pre-single fetch behavior ([#12506](https://github.com/remix-run/react-router/pull/12506))
840- Ignore redirects when inferring loader data types ([#12527](https://github.com/remix-run/react-router/pull/12527))
841- Remove `<Link prefetch>` warning which suffers from false positives in a lazy route discovery world ([#12485](https://github.com/remix-run/react-router/pull/12485))
842
843## 7.0.2
844
845### Patch Changes
846
847- temporarily only use one build in export map so packages can have a peer dependency on react router ([#12437](https://github.com/remix-run/react-router/pull/12437))
848- Generate wide `matches` and `params` types for current route and child routes ([#12397](https://github.com/remix-run/react-router/pull/12397))
849
850 At runtime, `matches` includes child route matches and `params` include child route path parameters.
851 But previously, we only generated types for parent routes in `matches`; for `params`, we only considered the parent routes and the current route.
852 To align our generated types more closely to the runtime behavior, we now generate more permissive, wider types when accessing child route information.
853
854## 7.0.1
855
856_No changes_
857
858## 7.0.0
859
860### Major Changes
861
862- 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))
863 - `defer`
864 - `AbortedDeferredError`
865 - `type TypedDeferredData`
866 - `UNSAFE_DeferredData`
867 - `UNSAFE_DEFERRED_SYMBOL`,
868
869- - Collapse `@remix-run/router` into `react-router` ([#11505](https://github.com/remix-run/react-router/pull/11505))
870 - Collapse `react-router-dom` into `react-router`
871 - Collapse `@remix-run/server-runtime` into `react-router`
872 - Collapse `@remix-run/testing` into `react-router`
873
874- Remove single fetch future flag. ([#11522](https://github.com/remix-run/react-router/pull/11522))
875
876- Drop support for Node 16, React Router SSR now requires Node 18 or higher ([#11391](https://github.com/remix-run/react-router/pull/11391))
877
878- Remove `future.v7_startTransition` flag ([#11696](https://github.com/remix-run/react-router/pull/11696))
879
880- - 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))
881 - `useNavigate()`
882 - `useSubmit`
883 - `useFetcher().load`
884 - `useFetcher().submit`
885 - `useRevalidator.revalidate`
886
887- Remove `future.v7_normalizeFormMethod` future flag ([#11697](https://github.com/remix-run/react-router/pull/11697))
888
889- 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))
890 - `createCookie`
891 - `createCookieSessionStorage`
892 - `createMemorySessionStorage`
893 - `createSessionStorage`
894
895 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)
896
897 Since platform-specific packages no longer need to implement this API, the following low-level APIs have been removed:
898 - `createCookieFactory`
899 - `createSessionStorageFactory`
900 - `createCookieSessionStorageFactory`
901 - `createMemorySessionStorageFactory`
902
903- Imports/Exports cleanup ([#11840](https://github.com/remix-run/react-router/pull/11840))
904 - Removed the following exports that were previously public API from `@remix-run/router`
905 - types
906 - `AgnosticDataIndexRouteObject`
907 - `AgnosticDataNonIndexRouteObject`
908 - `AgnosticDataRouteMatch`
909 - `AgnosticDataRouteObject`
910 - `AgnosticIndexRouteObject`
911 - `AgnosticNonIndexRouteObject`
912 - `AgnosticRouteMatch`
913 - `AgnosticRouteObject`
914 - `TrackedPromise`
915 - `unstable_AgnosticPatchRoutesOnMissFunction`
916 - `Action` -> exported as `NavigationType` via `react-router`
917 - `Router` exported as `DataRouter` to differentiate from RR's `<Router>`
918 - API
919 - `getToPathname` (`@private`)
920 - `joinPaths` (`@private`)
921 - `normalizePathname` (`@private`)
922 - `resolveTo` (`@private`)
923 - `stripBasename` (`@private`)
924 - `createBrowserHistory` -> in favor of `createBrowserRouter`
925 - `createHashHistory` -> in favor of `createHashRouter`
926 - `createMemoryHistory` -> in favor of `createMemoryRouter`
927 - `createRouter`
928 - `createStaticHandler` -> in favor of wrapper `createStaticHandler` in RR Dom
929 - `getStaticContextFromError`
930 - Removed the following exports that were previously public API from `react-router`
931 - `Hash`
932 - `Pathname`
933 - `Search`
934
935- update minimum node version to 18 ([#11690](https://github.com/remix-run/react-router/pull/11690))
936
937- Remove `future.v7_prependBasename` from the ionternalized `@remix-run/router` package ([#11726](https://github.com/remix-run/react-router/pull/11726))
938
939- Migrate Remix type generics to React Router ([#12180](https://github.com/remix-run/react-router/pull/12180))
940 - These generics are provided for Remix v2 migration purposes
941 - These generics and the APIs they exist on should be considered informally deprecated in favor of the new `Route.*` types
942 - Anyone migrating from React Router v6 should probably not leverage these new generics and should migrate straight to the `Route.*` types
943 - For React Router v6 users, these generics are new and should not impact your app, with one exception
944 - `useFetcher` previously had an optional generic (used primarily by Remix v2) that expected the data type
945 - This has been updated in v7 to expect the type of the function that generates the data (i.e., `typeof loader`/`typeof action`)
946 - Therefore, you should update your usages:
947 - ❌ `useFetcher<LoaderData>()`
948 - ✅ `useFetcher<typeof loader>()`
949
950- Remove `future.v7_throwAbortReason` from internalized `@remix-run/router` package ([#11728](https://github.com/remix-run/react-router/pull/11728))
951
952- Add `exports` field to all packages ([#11675](https://github.com/remix-run/react-router/pull/11675))
953
954- node package no longer re-exports from react-router ([#11702](https://github.com/remix-run/react-router/pull/11702))
955
956- renamed RemixContext to FrameworkContext ([#11705](https://github.com/remix-run/react-router/pull/11705))
957
958- updates the minimum React version to 18 ([#11689](https://github.com/remix-run/react-router/pull/11689))
959
960- PrefetchPageDescriptor replaced by PageLinkDescriptor ([#11960](https://github.com/remix-run/react-router/pull/11960))
961
962- - 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))
963 - Examples: `LoaderFunction`, `LoaderFunctionArgs`, `ActionFunction`, `ActionFunctionArgs`, `DataFunctionArgs`, `RouteManifest`, `LinksFunction`, `Route`, `EntryRoute`
964 - The `RouteManifest` type used by the "remix" code is now slightly stricter because it is using the former `@remix-run/router` `RouteManifest`
965 - `Record<string, Route> -> Record<string, Route | undefined>`
966 - Removed `AppData` type in favor of inlining `unknown` in the few locations it was used
967 - Removed `ServerRuntimeMeta*` types in favor of the `Meta*` types they were duplicated from
968
969- - Remove the `future.v7_partialHydration` flag ([#11725](https://github.com/remix-run/react-router/pull/11725))
970 - This also removes the `<RouterProvider fallbackElement>` prop
971 - To migrate, move the `fallbackElement` to a `hydrateFallbackElement`/`HydrateFallback` on your root route
972 - Also worth nothing there is a related breaking changer with this future flag:
973 - Without `future.v7_partialHydration` (when using `fallbackElement`), `state.navigation` was populated during the initial load
974 - With `future.v7_partialHydration`, `state.navigation` remains in an `"idle"` state during the initial load
975
976- Remove `v7_relativeSplatPath` future flag ([#11695](https://github.com/remix-run/react-router/pull/11695))
977
978- Drop support for Node 18, update minimum Node vestion to 20 ([#12171](https://github.com/remix-run/react-router/pull/12171))
979 - Remove `installGlobals()` as this should no longer be necessary
980
981- Remove remaining future flags ([#11820](https://github.com/remix-run/react-router/pull/11820))
982 - React Router `v7_skipActionErrorRevalidation`
983 - Remix `v3_fetcherPersist`, `v3_relativeSplatPath`, `v3_throwAbortReason`
984
985- rename createRemixStub to createRoutesStub ([#11692](https://github.com/remix-run/react-router/pull/11692))
986
987- Remove `@remix-run/router` deprecated `detectErrorBoundary` option in favor of `mapRouteProperties` ([#11751](https://github.com/remix-run/react-router/pull/11751))
988
989- 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))
990 - 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
991 - DOM environments should import from `react-router/dom` to get the proper component that makes `ReactDOM.flushSync()` available:
992 - If you are using the Vite plugin, use this in your `entry.client.tsx`:
993 - `import { HydratedRouter } from 'react-router/dom'`
994 - If you are not using the Vite plugin and are manually calling `createBrowserRouter`/`createHashRouter`:
995 - `import { RouterProvider } from "react-router/dom"`
996
997- Remove `future.v7_fetcherPersist` flag ([#11731](https://github.com/remix-run/react-router/pull/11731))
998
999- 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))
1000
1001### Minor Changes
1002
1003- - 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))
1004 - 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)
1005 - `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.
1006
1007 ```ts
1008 // react-router.config.ts
1009 import type { Config } from "@react-router/dev/config";
1010
1011 export default {
1012 async prerender() {
1013 let slugs = await fakeGetSlugsFromCms();
1014 // Prerender these paths into `.html` files at build time, and `.data`
1015 // files if they have loaders
1016 return ["/", "/about", ...slugs.map((slug) => `/product/${slug}`)];
1017 },
1018 } satisfies Config;
1019
1020 async function fakeGetSlugsFromCms() {
1021 await new Promise((r) => setTimeout(r, 1000));
1022 return ["shirt", "hat"];
1023 }
1024 ```
1025
1026- Params, loader data, and action data as props for route component exports ([#11961](https://github.com/remix-run/react-router/pull/11961))
1027
1028 ```tsx
1029 export default function Component({ params, loaderData, actionData }) {}
1030
1031 export function HydrateFallback({ params }) {}
1032 export function ErrorBoundary({ params, loaderData, actionData }) {}
1033 ```
1034
1035- Remove duplicate `RouterProvider` impliementations ([#11679](https://github.com/remix-run/react-router/pull/11679))
1036
1037- ### Typesafety improvements ([#12019](https://github.com/remix-run/react-router/pull/12019))
1038
1039 React Router now generates types for each of your route modules.
1040 You can access those types by importing them from `./+types.<route filename without extension>`.
1041 For example:
1042
1043 ```ts
1044 // app/routes/product.tsx
1045 import type * as Route from "./+types.product";
1046
1047 export function loader({ params }: Route.LoaderArgs) {}
1048
1049 export default function Component({ loaderData }: Route.ComponentProps) {}
1050 ```
1051
1052 This initial implementation targets type inference for:
1053 - `Params` : Path parameters from your routing config in `routes.ts` including file-based routing
1054 - `LoaderData` : Loader data from `loader` and/or `clientLoader` within your route module
1055 - `ActionData` : Action data from `action` and/or `clientAction` within your route module
1056
1057 In the future, we plan to add types for the rest of the route module exports: `meta`, `links`, `headers`, `shouldRevalidate`, etc.
1058 We also plan to generate types for typesafe `Link`s:
1059
1060 ```tsx
1061 <Link to="/products/:id" params={{ id: 1 }} />
1062 // ^^^^^^^^^^^^^ ^^^^^^^^^
1063 // typesafe `to` and `params` based on the available routes in your app
1064 ```
1065
1066 Check out our docs for more:
1067 - [_Explanations > Type Safety_](https://reactrouter.com/dev/guides/explanation/type-safety)
1068 - [_How-To > Setting up type safety_](https://reactrouter.com/dev/guides/how-to/setting-up-type-safety)
1069
1070- Stabilize `unstable_dataStrategy` ([#11969](https://github.com/remix-run/react-router/pull/11969))
1071
1072- Stabilize `unstable_patchRoutesOnNavigation` ([#11970](https://github.com/remix-run/react-router/pull/11970))
1073
1074### Patch Changes
1075
1076- No changes ([`506329c4e`](https://github.com/remix-run/react-router/commit/506329c4e2e7aba9837cbfa44df6103b49423745))
1077
1078- chore: re-enable development warnings through a `development` exports condition. ([#12269](https://github.com/remix-run/react-router/pull/12269))
1079
1080- Remove unstable upload handler. ([#12015](https://github.com/remix-run/react-router/pull/12015))
1081
1082- Remove unneeded dependency on @web3-storage/multipart-parser ([#12274](https://github.com/remix-run/react-router/pull/12274))
1083
1084- Fix redirects returned from loaders/actions using `data()` ([#12021](https://github.com/remix-run/react-router/pull/12021))
1085
1086- fix(react-router): (v7) fix static prerender of non-ascii characters ([#12161](https://github.com/remix-run/react-router/pull/12161))
1087
1088- Replace `substr` with `substring` ([#12080](https://github.com/remix-run/react-router/pull/12080))
1089
1090- Remove the deprecated `json` utility ([#12146](https://github.com/remix-run/react-router/pull/12146))
1091 - 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
1092
1093- Remove unneeded dependency on source-map ([#12275](https://github.com/remix-run/react-router/pull/12275))
1094
1095## 6.28.0
1096
1097### Minor Changes
1098
1099- - Log deprecation warnings for v7 flags ([#11750](https://github.com/remix-run/react-router/pull/11750))
1100 - Add deprecation warnings to `json`/`defer` in favor of returning raw objects
1101 - These methods will be removed in React Router v7
1102
1103### Patch Changes
1104
1105- Update JSDoc URLs for new website structure (add /v6/ segment) ([#12141](https://github.com/remix-run/react-router/pull/12141))
1106- Updated dependencies:
1107 - `@remix-run/router@1.21.0`
1108
1109## 6.27.0
1110
1111### Minor Changes
1112
1113- Stabilize `unstable_patchRoutesOnNavigation` ([#11973](https://github.com/remix-run/react-router/pull/11973))
1114 - Add new `PatchRoutesOnNavigationFunctionArgs` type for convenience ([#11967](https://github.com/remix-run/react-router/pull/11967))
1115- Stabilize `unstable_dataStrategy` ([#11974](https://github.com/remix-run/react-router/pull/11974))
1116- Stabilize the `unstable_flushSync` option for navigations and fetchers ([#11989](https://github.com/remix-run/react-router/pull/11989))
1117- Stabilize the `unstable_viewTransition` option for navigations and the corresponding `unstable_useViewTransitionState` hook ([#11989](https://github.com/remix-run/react-router/pull/11989))
1118
1119### Patch Changes
1120
1121- 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))
1122
1123- 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))
1124
1125- 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))
1126
1127- Updated dependencies:
1128 - `@remix-run/router@1.20.0`
1129
1130## 6.26.2
1131
1132### Patch Changes
1133
1134- Updated dependencies:
1135 - `@remix-run/router@1.19.2`
1136
1137## 6.26.1
1138
1139### Patch Changes
1140
1141- Rename `unstable_patchRoutesOnMiss` to `unstable_patchRoutesOnNavigation` to match new behavior ([#11888](https://github.com/remix-run/react-router/pull/11888))
1142- Updated dependencies:
1143 - `@remix-run/router@1.19.1`
1144
1145## 6.26.0
1146
1147### Minor Changes
1148
1149- 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))
1150
1151### Patch Changes
1152
1153- Fix initial hydration behavior when using `future.v7_partialHydration` along with `unstable_patchRoutesOnMiss` ([#11838](https://github.com/remix-run/react-router/pull/11838))
1154 - During initial hydration, `router.state.matches` will now include any partial matches so that we can render ancestor `HydrateFallback` components
1155- Updated dependencies:
1156 - `@remix-run/router@1.19.0`
1157
1158## 6.25.1
1159
1160No 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.
1161
1162## 6.25.0
1163
1164### Minor Changes
1165
1166- Stabilize `future.unstable_skipActionErrorRevalidation` as `future.v7_skipActionErrorRevalidation` ([#11769](https://github.com/remix-run/react-router/pull/11769))
1167 - When this flag is enabled, actions will not automatically trigger a revalidation if they return/throw a `Response` with a `4xx`/`5xx` status code
1168 - You may still opt-into revalidation via `shouldRevalidate`
1169 - This also changes `shouldRevalidate`'s `unstable_actionStatus` parameter to `actionStatus`
1170
1171### Patch Changes
1172
1173- Fix regression and properly decode paths inside `useMatch` so matches/params reflect decoded params ([#11789](https://github.com/remix-run/react-router/pull/11789))
1174- Updated dependencies:
1175 - `@remix-run/router@1.18.0`
1176
1177## 6.24.1
1178
1179### Patch Changes
1180
1181- 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))
1182- Updated dependencies:
1183 - `@remix-run/router@1.17.1`
1184
1185## 6.24.0
1186
1187### Minor Changes
1188
1189- Add support for Lazy Route Discovery (a.k.a. Fog of War) ([#11626](https://github.com/remix-run/react-router/pull/11626))
1190 - RFC: <https://github.com/remix-run/react-router/discussions/11113>
1191 - `unstable_patchRoutesOnMiss` docs: <https://reactrouter.com/v6/routers/create-browser-router>
1192
1193### Patch Changes
1194
1195- Updated dependencies:
1196 - `@remix-run/router@1.17.0`
1197
1198## 6.23.1
1199
1200### Patch Changes
1201
1202- allow undefined to be resolved with `<Await>` ([#11513](https://github.com/remix-run/react-router/pull/11513))
1203- Updated dependencies:
1204 - `@remix-run/router@1.16.1`
1205
1206## 6.23.0
1207
1208### Minor Changes
1209
1210- Add a new `unstable_dataStrategy` configuration option ([#11098](https://github.com/remix-run/react-router/pull/11098))
1211 - This option allows Data Router applications to take control over the approach for executing route loaders and actions
1212 - 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
1213
1214### Patch Changes
1215
1216- Updated dependencies:
1217 - `@remix-run/router@1.16.0`
1218
1219## 6.22.3
1220
1221### Patch Changes
1222
1223- Updated dependencies:
1224 - `@remix-run/router@1.15.3`
1225
1226## 6.22.2
1227
1228### Patch Changes
1229
1230- Updated dependencies:
1231 - `@remix-run/router@1.15.2`
1232
1233## 6.22.1
1234
1235### Patch Changes
1236
1237- Fix encoding/decoding issues with pre-encoded dynamic parameter values ([#11199](https://github.com/remix-run/react-router/pull/11199))
1238- Updated dependencies:
1239 - `@remix-run/router@1.15.1`
1240
1241## 6.22.0
1242
1243### Patch Changes
1244
1245- Updated dependencies:
1246 - `@remix-run/router@1.15.0`
1247
1248## 6.21.3
1249
1250### Patch Changes
1251
1252- Remove leftover `unstable_` prefix from `Blocker`/`BlockerFunction` types ([#11187](https://github.com/remix-run/react-router/pull/11187))
1253
1254## 6.21.2
1255
1256### Patch Changes
1257
1258- Updated dependencies:
1259 - `@remix-run/router@1.14.2`
1260
1261## 6.21.1
1262
1263### Patch Changes
1264
1265- 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))
1266- Updated dependencies:
1267 - `@remix-run/router@1.14.1`
1268
1269## 6.21.0
1270
1271### Minor Changes
1272
1273- 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))
1274
1275 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))
1276
1277 **The Bug**
1278 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.
1279
1280 **The Background**
1281 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:
1282
1283 ```jsx
1284 <BrowserRouter>
1285 <Routes>
1286 <Route path="/" element={<Home />} />
1287 <Route path="dashboard/*" element={<Dashboard />} />
1288 </Routes>
1289 </BrowserRouter>
1290 ```
1291
1292 Any paths like `/dashboard`, `/dashboard/team`, `/dashboard/projects` will match the `Dashboard` route. The dashboard component itself can then render nested `<Routes>`:
1293
1294 ```jsx
1295 function Dashboard() {
1296 return (
1297 <div>
1298 <h2>Dashboard</h2>
1299 <nav>
1300 <Link to="/">Dashboard Home</Link>
1301 <Link to="team">Team</Link>
1302 <Link to="projects">Projects</Link>
1303 </nav>
1304
1305 <Routes>
1306 <Route path="/" element={<DashboardHome />} />
1307 <Route path="team" element={<DashboardTeam />} />
1308 <Route path="projects" element={<DashboardProjects />} />
1309 </Routes>
1310 </div>
1311 );
1312 }
1313 ```
1314
1315 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.
1316
1317 **The Problem**
1318
1319 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 `"."`:
1320
1321 ```jsx
1322 // If we are on URL /dashboard/team, and we want to link to /dashboard/team:
1323 function DashboardTeam() {
1324 // ❌ This is broken and results in <a href="/dashboard">
1325 return <Link to=".">A broken link to the Current URL</Link>;
1326
1327 // ✅ This is fixed but super unintuitive since we're already at /dashboard/team!
1328 return <Link to="./team">A broken link to the Current URL</Link>;
1329 }
1330 ```
1331
1332 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.
1333
1334 Even worse, consider a nested splat route configuration:
1335
1336 ```jsx
1337 <BrowserRouter>
1338 <Routes>
1339 <Route path="dashboard">
1340 <Route path="*" element={<Dashboard />} />
1341 </Route>
1342 </Routes>
1343 </BrowserRouter>
1344 ```
1345
1346 Now, a `<Link to=".">` and a `<Link to="..">` inside the `Dashboard` component go to the same place! That is definitely not correct!
1347
1348 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:
1349
1350 ```jsx
1351 let router = createBrowserRouter({
1352 path: "/dashboard",
1353 children: [
1354 {
1355 path: "*",
1356 action: dashboardAction,
1357 Component() {
1358 // ❌ This form is broken! It throws a 405 error when it submits because
1359 // it tries to submit to /dashboard (without the splat value) and the parent
1360 // `/dashboard` route doesn't have an action
1361 return <Form method="post">...</Form>;
1362 },
1363 },
1364 ],
1365 });
1366 ```
1367
1368 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.
1369
1370 **The Solution**
1371 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:
1372
1373 ```jsx
1374 <BrowserRouter>
1375 <Routes>
1376 <Route path="dashboard">
1377 <Route index path="*" element={<Dashboard />} />
1378 </Route>
1379 </Routes>
1380 </BrowserRouter>
1381
1382 function Dashboard() {
1383 return (
1384 <div>
1385 <h2>Dashboard</h2>
1386 <nav>
1387 <Link to="..">Dashboard Home</Link>
1388 <Link to="../team">Team</Link>
1389 <Link to="../projects">Projects</Link>
1390 </nav>
1391
1392 <Routes>
1393 <Route path="/" element={<DashboardHome />} />
1394 <Route path="team" element={<DashboardTeam />} />
1395 <Route path="projects" element={<DashboardProjects />} />
1396 </Router>
1397 </div>
1398 );
1399 }
1400 ```
1401
1402 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".
1403
1404### Patch Changes
1405
1406- Properly handle falsy error values in ErrorBoundary's ([#11071](https://github.com/remix-run/react-router/pull/11071))
1407- Updated dependencies:
1408 - `@remix-run/router@1.14.0`
1409
1410## 6.20.1
1411
1412### Patch Changes
1413
1414- 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))
1415- Updated dependencies:
1416 - `@remix-run/router@1.13.1`
1417
1418## 6.20.0
1419
1420### Minor Changes
1421
1422- Export the `PathParam` type from the public API ([#10719](https://github.com/remix-run/react-router/pull/10719))
1423
1424### Patch Changes
1425
1426- Fix bug with `resolveTo` in splat routes ([#11045](https://github.com/remix-run/react-router/pull/11045))
1427 - 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`
1428 - This removes the `UNSAFE_getPathContributingMatches` export from `@remix-run/router` since we no longer need this in the `react-router`/`react-router-dom` layers
1429- Updated dependencies:
1430 - `@remix-run/router@1.13.0`
1431
1432## 6.19.0
1433
1434### Minor Changes
1435
1436- 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))
1437- 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))
1438
1439### Patch Changes
1440
1441- 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))
1442
1443- 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))
1444 - ⚠️ 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.
1445
1446- Updated dependencies:
1447 - `@remix-run/router@1.12.0`
1448
1449## 6.18.0
1450
1451### Patch Changes
1452
1453- 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))
1454- Updated dependencies:
1455 - `@remix-run/router@1.11.0`
1456
1457## 6.17.0
1458
1459### Patch Changes
1460
1461- 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))
1462- Updated dependencies:
1463 - `@remix-run/router@1.10.0`
1464
1465## 6.16.0
1466
1467### Minor Changes
1468
1469- 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))
1470 - `Location` now accepts a generic for the `location.state` value
1471 - `ActionFunctionArgs`/`ActionFunction`/`LoaderFunctionArgs`/`LoaderFunction` now accept a generic for the `context` parameter (only used in SSR usages via `createStaticHandler`)
1472 - 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`
1473- 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))
1474- Export `ShouldRevalidateFunctionArgs` interface ([#10797](https://github.com/remix-run/react-router/pull/10797))
1475- 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))
1476
1477### Patch Changes
1478
1479- Updated dependencies:
1480 - `@remix-run/router@1.9.0`
1481
1482## 6.15.0
1483
1484### Minor Changes
1485
1486- 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))
1487
1488### Patch Changes
1489
1490- Ensure `useRevalidator` is referentially stable across re-renders if revalidations are not actively occurring ([#10707](https://github.com/remix-run/react-router/pull/10707))
1491- Updated dependencies:
1492 - `@remix-run/router@1.8.0`
1493
1494## 6.14.2
1495
1496### Patch Changes
1497
1498- Updated dependencies:
1499 - `@remix-run/router@1.7.2`
1500
1501## 6.14.1
1502
1503### Patch Changes
1504
1505- Fix loop in `unstable_useBlocker` when used with an unstable blocker function ([#10652](https://github.com/remix-run/react-router/pull/10652))
1506- Fix issues with reused blockers on subsequent navigations ([#10656](https://github.com/remix-run/react-router/pull/10656))
1507- Updated dependencies:
1508 - `@remix-run/router@1.7.1`
1509
1510## 6.14.0
1511
1512### Patch Changes
1513
1514- Strip `basename` from locations provided to `unstable_useBlocker` functions to match `useLocation` ([#10573](https://github.com/remix-run/react-router/pull/10573))
1515- Fix `generatePath` when passed a numeric `0` value parameter ([#10612](https://github.com/remix-run/react-router/pull/10612))
1516- Fix `unstable_useBlocker` key issues in `StrictMode` ([#10573](https://github.com/remix-run/react-router/pull/10573))
1517- Fix `tsc --skipLibCheck:false` issues on React 17 ([#10622](https://github.com/remix-run/react-router/pull/10622))
1518- Upgrade `typescript` to 5.1 ([#10581](https://github.com/remix-run/react-router/pull/10581))
1519- Updated dependencies:
1520 - `@remix-run/router@1.7.0`
1521
1522## 6.13.0
1523
1524### Minor Changes
1525
1526- 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))
1527
1528 Existing behavior will no longer include `React.startTransition`:
1529
1530 ```jsx
1531 <BrowserRouter>
1532 <Routes>{/*...*/}</Routes>
1533 </BrowserRouter>
1534
1535 <RouterProvider router={router} />
1536 ```
1537
1538 If you wish to enable `React.startTransition`, pass the future flag to your component:
1539
1540 ```jsx
1541 <BrowserRouter future={{ v7_startTransition: true }}>
1542 <Routes>{/*...*/}</Routes>
1543 </BrowserRouter>
1544
1545 <RouterProvider router={router} future={{ v7_startTransition: true }}/>
1546 ```
1547
1548### Patch Changes
1549
1550- Work around webpack/terser `React.startTransition` minification bug in production mode ([#10588](https://github.com/remix-run/react-router/pull/10588))
1551
1552## 6.12.1
1553
1554> \[!WARNING]
1555> 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.
1556
1557### Patch Changes
1558
1559- Adjust feature detection of `React.startTransition` to fix webpack + react 17 compilation error ([#10569](https://github.com/remix-run/react-router/pull/10569))
1560
1561## 6.12.0
1562
1563### Minor Changes
1564
1565- Wrap internal router state updates with `React.startTransition` if it exists ([#10438](https://github.com/remix-run/react-router/pull/10438))
1566
1567### Patch Changes
1568
1569- Updated dependencies:
1570 - `@remix-run/router@1.6.3`
1571
1572## 6.11.2
1573
1574### Patch Changes
1575
1576- Fix `basename` duplication in descendant `<Routes>` inside a `<RouterProvider>` ([#10492](https://github.com/remix-run/react-router/pull/10492))
1577- Updated dependencies:
1578 - `@remix-run/router@1.6.2`
1579
1580## 6.11.1
1581
1582### Patch Changes
1583
1584- Fix usage of `Component` API within descendant `<Routes>` ([#10434](https://github.com/remix-run/react-router/pull/10434))
1585- Fix bug when calling `useNavigate` from `<Routes>` inside a `<RouterProvider>` ([#10432](https://github.com/remix-run/react-router/pull/10432))
1586- Fix usage of `<Navigate>` in strict mode when using a data router ([#10435](https://github.com/remix-run/react-router/pull/10435))
1587- Updated dependencies:
1588 - `@remix-run/router@1.6.1`
1589
1590## 6.11.0
1591
1592### Patch Changes
1593
1594- Log loader/action errors to the console in dev for easier stack trace evaluation ([#10286](https://github.com/remix-run/react-router/pull/10286))
1595- Fix bug preventing rendering of descendant `<Routes>` when `RouterProvider` errors existed ([#10374](https://github.com/remix-run/react-router/pull/10374))
1596- Fix inadvertent re-renders when using `Component` instead of `element` on a route definition ([#10287](https://github.com/remix-run/react-router/pull/10287))
1597- 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))
1598- 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))
1599- Allow `useRevalidator()` to resolve a loader-driven error boundary scenario ([#10369](https://github.com/remix-run/react-router/pull/10369))
1600- Avoid unnecessary unsubscribe/resubscribes on router state changes ([#10409](https://github.com/remix-run/react-router/pull/10409))
1601- 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))
1602- Updated dependencies:
1603 - `@remix-run/router@1.6.0`
1604
1605## 6.10.0
1606
1607### Minor Changes
1608
1609- 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))
1610 - When `future.v7_normalizeFormMethod === false` (default v6 behavior),
1611 - `useNavigation().formMethod` is lowercase
1612 - `useFetcher().formMethod` is lowercase
1613 - When `future.v7_normalizeFormMethod === true`:
1614 - `useNavigation().formMethod` is uppercase
1615 - `useFetcher().formMethod` is uppercase
1616
1617### Patch Changes
1618
1619- Fix route ID generation when using Fragments in `createRoutesFromElements` ([#10193](https://github.com/remix-run/react-router/pull/10193))
1620- Updated dependencies:
1621 - `@remix-run/router@1.5.0`
1622
1623## 6.9.0
1624
1625### Minor Changes
1626
1627- 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))
1628
1629 **Example JSON Syntax**
1630
1631 ```jsx
1632 // Both of these work the same:
1633 const elementRoutes = [{
1634 path: '/',
1635 element: <Home />,
1636 errorElement: <HomeError />,
1637 }]
1638
1639 const componentRoutes = [{
1640 path: '/',
1641 Component: Home,
1642 ErrorBoundary: HomeError,
1643 }]
1644
1645 function Home() { ... }
1646 function HomeError() { ... }
1647 ```
1648
1649 **Example JSX Syntax**
1650
1651 ```jsx
1652 // Both of these work the same:
1653 const elementRoutes = createRoutesFromElements(
1654 <Route path='/' element={<Home />} errorElement={<HomeError /> } />
1655 );
1656
1657 const componentRoutes = createRoutesFromElements(
1658 <Route path='/' Component={Home} ErrorBoundary={HomeError} />
1659 );
1660
1661 function Home() { ... }
1662 function HomeError() { ... }
1663 ```
1664
1665- **Introducing Lazy Route Modules!** ([#10045](https://github.com/remix-run/react-router/pull/10045))
1666
1667 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`).
1668
1669 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.
1670
1671 Your `lazy` functions will typically return the result of a dynamic import.
1672
1673 ```jsx
1674 // In this example, we assume most folks land on the homepage so we include that
1675 // in our critical-path bundle, but then we lazily load modules for /a and /b so
1676 // they don't load until the user navigates to those routes
1677 let routes = createRoutesFromElements(
1678 <Route path="/" element={<Layout />}>
1679 <Route index element={<Home />} />
1680 <Route path="a" lazy={() => import("./a")} />
1681 <Route path="b" lazy={() => import("./b")} />
1682 </Route>,
1683 );
1684 ```
1685
1686 Then in your lazy route modules, export the properties you want defined for the route:
1687
1688 ```jsx
1689 export async function loader({ request }) {
1690 let data = await fetchData(request);
1691 return json(data);
1692 }
1693
1694 // Export a `Component` directly instead of needing to create a React Element from it
1695 export function Component() {
1696 let data = useLoaderData();
1697
1698 return (
1699 <>
1700 <h1>You made it!</h1>
1701 <p>{data}</p>
1702 </>
1703 );
1704 }
1705
1706 // Export an `ErrorBoundary` directly instead of needing to create a React Element from it
1707 export function ErrorBoundary() {
1708 let error = useRouteError();
1709 return isRouteErrorResponse(error) ? (
1710 <h1>
1711 {error.status} {error.statusText}
1712 </h1>
1713 ) : (
1714 <h1>{error.message || error}</h1>
1715 );
1716 }
1717 ```
1718
1719 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.
1720
1721 🙌 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).
1722
1723- Updated dependencies:
1724 - `@remix-run/router@1.4.0`
1725
1726### Patch Changes
1727
1728- Fix `generatePath` incorrectly applying parameters in some cases ([#10078](https://github.com/remix-run/react-router/pull/10078))
1729- Improve memoization for context providers to avoid unnecessary re-renders ([#9983](https://github.com/remix-run/react-router/pull/9983))
1730
1731## 6.8.2
1732
1733### Patch Changes
1734
1735- Updated dependencies:
1736 - `@remix-run/router@1.3.3`
1737
1738## 6.8.1
1739
1740### Patch Changes
1741
1742- Remove inaccurate console warning for POP navigations and update active blocker logic ([#10030](https://github.com/remix-run/react-router/pull/10030))
1743- Updated dependencies:
1744 - `@remix-run/router@1.3.2`
1745
1746## 6.8.0
1747
1748### Patch Changes
1749
1750- Updated dependencies:
1751 - `@remix-run/router@1.3.1`
1752
1753## 6.7.0
1754
1755### Minor Changes
1756
1757- Add `unstable_useBlocker` hook for blocking navigations within the app's location origin ([#9709](https://github.com/remix-run/react-router/pull/9709))
1758
1759### Patch Changes
1760
1761- Fix `generatePath` when optional params are present ([#9764](https://github.com/remix-run/react-router/pull/9764))
1762- Update `<Await>` to accept `ReactNode` as children function return result ([#9896](https://github.com/remix-run/react-router/pull/9896))
1763- Updated dependencies:
1764 - `@remix-run/router@1.3.0`
1765
1766## 6.6.2
1767
1768### Patch Changes
1769
1770- Ensure `useId` consistency during SSR ([#9805](https://github.com/remix-run/react-router/pull/9805))
1771
1772## 6.6.1
1773
1774### Patch Changes
1775
1776- Updated dependencies:
1777 - `@remix-run/router@1.2.1`
1778
1779## 6.6.0
1780
1781### Patch Changes
1782
1783- Prevent `useLoaderData` usage in `errorElement` ([#9735](https://github.com/remix-run/react-router/pull/9735))
1784- Updated dependencies:
1785 - `@remix-run/router@1.2.0`
1786
1787## 6.5.0
1788
1789This 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.
1790
1791**Optional Params Examples**
1792
1793- `<Route path=":lang?/about>` will match:
1794 - `/:lang/about`
1795 - `/about`
1796- `<Route path="/multistep/:widget1?/widget2?/widget3?">` will match:
1797 - `/multistep`
1798 - `/multistep/:widget1`
1799 - `/multistep/:widget1/:widget2`
1800 - `/multistep/:widget1/:widget2/:widget3`
1801
1802**Optional Static Segment Example**
1803
1804- `<Route path="/home?">` will match:
1805 - `/`
1806 - `/home`
1807- `<Route path="/fr?/about">` will match:
1808 - `/about`
1809 - `/fr/about`
1810
1811### Minor Changes
1812
1813- Allows optional routes and optional static segments ([#9650](https://github.com/remix-run/react-router/pull/9650))
1814
1815### Patch Changes
1816
1817- 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))
1818
1819```jsx
1820// Old behavior at URL /prefix-123
1821<Route path="prefix-:id" element={<Comp /> }>
1822
1823function Comp() {
1824 let params = useParams(); // { id: '123' }
1825 let id = params.id; // "123"
1826 ...
1827}
1828
1829// New behavior at URL /prefix-123
1830<Route path=":id" element={<Comp /> }>
1831
1832function Comp() {
1833 let params = useParams(); // { id: 'prefix-123' }
1834 let id = params.id.replace(/^prefix-/, ''); // "123"
1835 ...
1836}
1837```
1838
1839- Updated dependencies:
1840 - `@remix-run/router@1.1.0`
1841
1842## 6.4.5
1843
1844### Patch Changes
1845
1846- Updated dependencies:
1847 - `@remix-run/router@1.0.5`
1848
1849## 6.4.4
1850
1851### Patch Changes
1852
1853- Updated dependencies:
1854 - `@remix-run/router@1.0.4`
1855
1856## 6.4.3
1857
1858### Patch Changes
1859
1860- `useRoutes` should be able to return `null` when passing `locationArg` ([#9485](https://github.com/remix-run/react-router/pull/9485))
1861- fix `initialEntries` type in `createMemoryRouter` ([#9498](https://github.com/remix-run/react-router/pull/9498))
1862- Updated dependencies:
1863 - `@remix-run/router@1.0.3`
1864
1865## 6.4.2
1866
1867### Patch Changes
1868
1869- Fix `IndexRouteObject` and `NonIndexRouteObject` types to make `hasErrorElement` optional ([#9394](https://github.com/remix-run/react-router/pull/9394))
1870- Enhance console error messages for invalid usage of data router hooks ([#9311](https://github.com/remix-run/react-router/pull/9311))
1871- 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))
1872- Updated dependencies:
1873 - `@remix-run/router@1.0.2`
1874
1875## 6.4.1
1876
1877### Patch Changes
1878
1879- Preserve state from `initialEntries` ([#9288](https://github.com/remix-run/react-router/pull/9288))
1880- Updated dependencies:
1881 - `@remix-run/router@1.0.1`
1882
1883## 6.4.0
1884
1885Whoa 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).
1886
1887**New APIs**
1888
1889- Create your router with `createMemoryRouter`
1890- Render your router with `<RouterProvider>`
1891- Load data with a Route `loader` and mutate with a Route `action`
1892- Handle errors with Route `errorElement`
1893- Defer non-critical data with `defer` and `Await`
1894
1895**Bug Fixes**
1896
1897- Path resolution is now trailing slash agnostic (#8861)
1898- `useLocation` returns the scoped location inside a `<Routes location>` component (#9094)
1899
1900**Updated Dependencies**
1901
1902- `@remix-run/router@1.0.0`