UNPKG

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