Combinatronics

28.3 kBMarkdownView Raw
1# `react-router`
2
3## 6.22.0
4
5### Patch Changes
6
7- Updated dependencies:
8 - `@remix-run/router@1.15.0`
9
10## 6.21.3
11
12### Patch Changes
13
14- Remove leftover `unstable_` prefix from `Blocker`/`BlockerFunction` types ([#11187](https://github.com/remix-run/react-router/pull/11187))
15
16## 6.21.2
17
18### Patch Changes
19
20- Updated dependencies:
21 - `@remix-run/router@1.14.2`
22
23## 6.21.1
24
25### Patch Changes
26
27- 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))
28- Updated dependencies:
29 - `@remix-run/router@1.14.1`
30
31## 6.21.0
32
33### Minor Changes
34
35- 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))
36
37 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))
38
39 **The Bug**
40 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.
41
42 **The Background**
43 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:
44
45 ```jsx
46 <BrowserRouter>
47 <Routes>
48 <Route path="/" element={<Home />} />
49 <Route path="dashboard/*" element={<Dashboard />} />
50 </Routes>
51 </BrowserRouter>
52 ```
53
54 Any paths like `/dashboard`, `/dashboard/team`, `/dashboard/projects` will match the `Dashboard` route. The dashboard component itself can then render nested `<Routes>`:
55
56 ```jsx
57 function Dashboard() {
58 return (
59 <div>
60 <h2>Dashboard</h2>
61 <nav>
62 <Link to="/">Dashboard Home</Link>
63 <Link to="team">Team</Link>
64 <Link to="projects">Projects</Link>
65 </nav>
66
67 <Routes>
68 <Route path="/" element={<DashboardHome />} />
69 <Route path="team" element={<DashboardTeam />} />
70 <Route path="projects" element={<DashboardProjects />} />
71 </Routes>
72 </div>
73 );
74 }
75 ```
76
77 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.
78
79 **The Problem**
80
81 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 `"."`:
82
83 ```jsx
84 // If we are on URL /dashboard/team, and we want to link to /dashboard/team:
85 function DashboardTeam() {
86 // ❌ This is broken and results in <a href="/dashboard">
87 return <Link to=".">A broken link to the Current URL</Link>;
88
89 // ✅ This is fixed but super unintuitive since we're already at /dashboard/team!
90 return <Link to="./team">A broken link to the Current URL</Link>;
91 }
92 ```
93
94 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.
95
96 Even worse, consider a nested splat route configuration:
97
98 ```jsx
99 <BrowserRouter>
100 <Routes>
101 <Route path="dashboard">
102 <Route path="*" element={<Dashboard />} />
103 </Route>
104 </Routes>
105 </BrowserRouter>
106 ```
107
108 Now, a `<Link to=".">` and a `<Link to="..">` inside the `Dashboard` component go to the same place! That is definitely not correct!
109
110 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:
111
112 ```jsx
113 let router = createBrowserRouter({
114 path: "/dashboard",
115 children: [
116 {
117 path: "*",
118 action: dashboardAction,
119 Component() {
120 // ❌ This form is broken! It throws a 405 error when it submits because
121 // it tries to submit to /dashboard (without the splat value) and the parent
122 // `/dashboard` route doesn't have an action
123 return <Form method="post">...</Form>;
124 },
125 },
126 ],
127 });
128 ```
129
130 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.
131
132 **The Solution**
133 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:
134
135 ```jsx
136 <BrowserRouter>
137 <Routes>
138 <Route path="dashboard">
139 <Route index path="*" element={<Dashboard />} />
140 </Route>
141 </Routes>
142 </BrowserRouter>
143
144 function Dashboard() {
145 return (
146 <div>
147 <h2>Dashboard</h2>
148 <nav>
149 <Link to="..">Dashboard Home</Link>
150 <Link to="../team">Team</Link>
151 <Link to="../projects">Projects</Link>
152 </nav>
153
154 <Routes>
155 <Route path="/" element={<DashboardHome />} />
156 <Route path="team" element={<DashboardTeam />} />
157 <Route path="projects" element={<DashboardProjects />} />
158 </Router>
159 </div>
160 );
161 }
162 ```
163
164 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".
165
166### Patch Changes
167
168- Properly handle falsy error values in ErrorBoundary's ([#11071](https://github.com/remix-run/react-router/pull/11071))
169- Updated dependencies:
170 - `@remix-run/router@1.14.0`
171
172## 6.20.1
173
174### Patch Changes
175
176- 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))
177- Updated dependencies:
178 - `@remix-run/router@1.13.1`
179
180## 6.20.0
181
182### Minor Changes
183
184- Export the `PathParam` type from the public API ([#10719](https://github.com/remix-run/react-router/pull/10719))
185
186### Patch Changes
187
188- Fix bug with `resolveTo` in splat routes ([#11045](https://github.com/remix-run/react-router/pull/11045))
189 - 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`
190 - This removes the `UNSAFE_getPathContributingMatches` export from `@remix-run/router` since we no longer need this in the `react-router`/`react-router-dom` layers
191- Updated dependencies:
192 - `@remix-run/router@1.13.0`
193
194## 6.19.0
195
196### Minor Changes
197
198- 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))
199- Remove the `unstable_` prefix from the [`useBlocker`](https://reactrouter.com/en/main/hooks/use-blocker) hook as it's been in use for enough time that we are confident in the API. We do not plan to remove the prefix from `unstable_usePrompt` due to differences in how browsers handle `window.confirm` that prevent React Router from guaranteeing consistent/correct behavior. ([#10991](https://github.com/remix-run/react-router/pull/10991))
200
201### Patch Changes
202
203- 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))
204
205- 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))
206
207 - ⚠️ 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.
208
209- Updated dependencies:
210 - `@remix-run/router@1.12.0`
211
212## 6.18.0
213
214### Patch Changes
215
216- 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))
217- Updated dependencies:
218 - `@remix-run/router@1.11.0`
219
220## 6.17.0
221
222### Patch Changes
223
224- 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))
225- Updated dependencies:
226 - `@remix-run/router@1.10.0`
227
228## 6.16.0
229
230### Minor Changes
231
232- 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))
233 - `Location` now accepts a generic for the `location.state` value
234 - `ActionFunctionArgs`/`ActionFunction`/`LoaderFunctionArgs`/`LoaderFunction` now accept a generic for the `context` parameter (only used in SSR usages via `createStaticHandler`)
235 - 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`
236- 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))
237- Export `ShouldRevalidateFunctionArgs` interface ([#10797](https://github.com/remix-run/react-router/pull/10797))
238- 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))
239
240### Patch Changes
241
242- Updated dependencies:
243 - `@remix-run/router@1.9.0`
244
245## 6.15.0
246
247### Minor Changes
248
249- 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))
250
251### Patch Changes
252
253- Ensure `useRevalidator` is referentially stable across re-renders if revalidations are not actively occurring ([#10707](https://github.com/remix-run/react-router/pull/10707))
254- Updated dependencies:
255 - `@remix-run/router@1.8.0`
256
257## 6.14.2
258
259### Patch Changes
260
261- Updated dependencies:
262 - `@remix-run/router@1.7.2`
263
264## 6.14.1
265
266### Patch Changes
267
268- Fix loop in `unstable_useBlocker` when used with an unstable blocker function ([#10652](https://github.com/remix-run/react-router/pull/10652))
269- Fix issues with reused blockers on subsequent navigations ([#10656](https://github.com/remix-run/react-router/pull/10656))
270- Updated dependencies:
271 - `@remix-run/router@1.7.1`
272
273## 6.14.0
274
275### Patch Changes
276
277- Strip `basename` from locations provided to `unstable_useBlocker` functions to match `useLocation` ([#10573](https://github.com/remix-run/react-router/pull/10573))
278- Fix `generatePath` when passed a numeric `0` value parameter ([#10612](https://github.com/remix-run/react-router/pull/10612))
279- Fix `unstable_useBlocker` key issues in `StrictMode` ([#10573](https://github.com/remix-run/react-router/pull/10573))
280- Fix `tsc --skipLibCheck:false` issues on React 17 ([#10622](https://github.com/remix-run/react-router/pull/10622))
281- Upgrade `typescript` to 5.1 ([#10581](https://github.com/remix-run/react-router/pull/10581))
282- Updated dependencies:
283 - `@remix-run/router@1.7.0`
284
285## 6.13.0
286
287### Minor Changes
288
289- Move [`React.startTransition`](https://react.dev/reference/react/startTransition) usage behind a [future flag](https://reactrouter.com/en/main/guides/api-development-strategy) to avoid issues with existing incompatible `Suspense` usages. We recommend folks adopting this flag to be better compatible with React concurrent mode, but if you run into issues you can continue without the use of `startTransition` until v7. Issues usually boils down to creating net-new promises during the render cycle, so if you run into issues you should either lift your promise creation out of the render cycle or put it behind a `useMemo`. ([#10596](https://github.com/remix-run/react-router/pull/10596))
290
291 Existing behavior will no longer include `React.startTransition`:
292
293 ```jsx
294 <BrowserRouter>
295 <Routes>{/*...*/}</Routes>
296 </BrowserRouter>
297
298 <RouterProvider router={router} />
299 ```
300
301 If you wish to enable `React.startTransition`, pass the future flag to your component:
302
303 ```jsx
304 <BrowserRouter future={{ v7_startTransition: true }}>
305 <Routes>{/*...*/}</Routes>
306 </BrowserRouter>
307
308 <RouterProvider router={router} future={{ v7_startTransition: true }}/>
309 ```
310
311### Patch Changes
312
313- Work around webpack/terser `React.startTransition` minification bug in production mode ([#10588](https://github.com/remix-run/react-router/pull/10588))
314
315## 6.12.1
316
317> \[!WARNING]
318> 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.
319
320### Patch Changes
321
322- Adjust feature detection of `React.startTransition` to fix webpack + react 17 compilation error ([#10569](https://github.com/remix-run/react-router/pull/10569))
323
324## 6.12.0
325
326### Minor Changes
327
328- Wrap internal router state updates with `React.startTransition` if it exists ([#10438](https://github.com/remix-run/react-router/pull/10438))
329
330### Patch Changes
331
332- Updated dependencies:
333 - `@remix-run/router@1.6.3`
334
335## 6.11.2
336
337### Patch Changes
338
339- Fix `basename` duplication in descendant `<Routes>` inside a `<RouterProvider>` ([#10492](https://github.com/remix-run/react-router/pull/10492))
340- Updated dependencies:
341 - `@remix-run/router@1.6.2`
342
343## 6.11.1
344
345### Patch Changes
346
347- Fix usage of `Component` API within descendant `<Routes>` ([#10434](https://github.com/remix-run/react-router/pull/10434))
348- Fix bug when calling `useNavigate` from `<Routes>` inside a `<RouterProvider>` ([#10432](https://github.com/remix-run/react-router/pull/10432))
349- Fix usage of `<Navigate>` in strict mode when using a data router ([#10435](https://github.com/remix-run/react-router/pull/10435))
350- Updated dependencies:
351 - `@remix-run/router@1.6.1`
352
353## 6.11.0
354
355### Patch Changes
356
357- Log loader/action errors to the console in dev for easier stack trace evaluation ([#10286](https://github.com/remix-run/react-router/pull/10286))
358- Fix bug preventing rendering of descendant `<Routes>` when `RouterProvider` errors existed ([#10374](https://github.com/remix-run/react-router/pull/10374))
359- Fix inadvertent re-renders when using `Component` instead of `element` on a route definition ([#10287](https://github.com/remix-run/react-router/pull/10287))
360- 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))
361- 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))
362- Allow `useRevalidator()` to resolve a loader-driven error boundary scenario ([#10369](https://github.com/remix-run/react-router/pull/10369))
363- Avoid unnecessary unsubscribe/resubscribes on router state changes ([#10409](https://github.com/remix-run/react-router/pull/10409))
364- 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))
365- Updated dependencies:
366 - `@remix-run/router@1.6.0`
367
368## 6.10.0
369
370### Minor Changes
371
372- Added support for [**Future Flags**](https://reactrouter.com/en/main/guides/api-development-strategy) in React Router. The first flag being introduced is `future.v7_normalizeFormMethod` which will normalize the exposed `useNavigation()/useFetcher()` `formMethod` fields as uppercase HTTP methods to align with the `fetch()` behavior. ([#10207](https://github.com/remix-run/react-router/pull/10207))
373
374 - When `future.v7_normalizeFormMethod === false` (default v6 behavior),
375 - `useNavigation().formMethod` is lowercase
376 - `useFetcher().formMethod` is lowercase
377 - When `future.v7_normalizeFormMethod === true`:
378 - `useNavigation().formMethod` is uppercase
379 - `useFetcher().formMethod` is uppercase
380
381### Patch Changes
382
383- Fix route ID generation when using Fragments in `createRoutesFromElements` ([#10193](https://github.com/remix-run/react-router/pull/10193))
384- Updated dependencies:
385 - `@remix-run/router@1.5.0`
386
387## 6.9.0
388
389### Minor Changes
390
391- 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))
392
393 **Example JSON Syntax**
394
395 ```jsx
396 // Both of these work the same:
397 const elementRoutes = [{
398 path: '/',
399 element: <Home />,
400 errorElement: <HomeError />,
401 }]
402
403 const componentRoutes = [{
404 path: '/',
405 Component: Home,
406 ErrorBoundary: HomeError,
407 }]
408
409 function Home() { ... }
410 function HomeError() { ... }
411 ```
412
413 **Example JSX Syntax**
414
415 ```jsx
416 // Both of these work the same:
417 const elementRoutes = createRoutesFromElements(
418 <Route path='/' element={<Home />} errorElement={<HomeError /> } />
419 );
420
421 const componentRoutes = createRoutesFromElements(
422 <Route path='/' Component={Home} ErrorBoundary={HomeError} />
423 );
424
425 function Home() { ... }
426 function HomeError() { ... }
427 ```
428
429- **Introducing Lazy Route Modules!** ([#10045](https://github.com/remix-run/react-router/pull/10045))
430
431 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`).
432
433 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.
434
435 Your `lazy` functions will typically return the result of a dynamic import.
436
437 ```jsx
438 // In this example, we assume most folks land on the homepage so we include that
439 // in our critical-path bundle, but then we lazily load modules for /a and /b so
440 // they don't load until the user navigates to those routes
441 let routes = createRoutesFromElements(
442 <Route path="/" element={<Layout />}>
443 <Route index element={<Home />} />
444 <Route path="a" lazy={() => import("./a")} />
445 <Route path="b" lazy={() => import("./b")} />
446 </Route>
447 );
448 ```
449
450 Then in your lazy route modules, export the properties you want defined for the route:
451
452 ```jsx
453 export async function loader({ request }) {
454 let data = await fetchData(request);
455 return json(data);
456 }
457
458 // Export a `Component` directly instead of needing to create a React Element from it
459 export function Component() {
460 let data = useLoaderData();
461
462 return (
463 <>
464 <h1>You made it!</h1>
465 <p>{data}</p>
466 </>
467 );
468 }
469
470 // Export an `ErrorBoundary` directly instead of needing to create a React Element from it
471 export function ErrorBoundary() {
472 let error = useRouteError();
473 return isRouteErrorResponse(error) ? (
474 <h1>
475 {error.status} {error.statusText}
476 </h1>
477 ) : (
478 <h1>{error.message || error}</h1>
479 );
480 }
481 ```
482
483 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.
484
485 🙌 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).
486
487- Updated dependencies:
488 - `@remix-run/router@1.4.0`
489
490### Patch Changes
491
492- Fix `generatePath` incorrectly applying parameters in some cases ([#10078](https://github.com/remix-run/react-router/pull/10078))
493- Improve memoization for context providers to avoid unnecessary re-renders ([#9983](https://github.com/remix-run/react-router/pull/9983))
494
495## 6.8.2
496
497### Patch Changes
498
499- Updated dependencies:
500 - `@remix-run/router@1.3.3`
501
502## 6.8.1
503
504### Patch Changes
505
506- Remove inaccurate console warning for POP navigations and update active blocker logic ([#10030](https://github.com/remix-run/react-router/pull/10030))
507- Updated dependencies:
508 - `@remix-run/router@1.3.2`
509
510## 6.8.0
511
512### Patch Changes
513
514- Updated dependencies:
515 - `@remix-run/router@1.3.1`
516
517## 6.7.0
518
519### Minor Changes
520
521- Add `unstable_useBlocker` hook for blocking navigations within the app's location origin ([#9709](https://github.com/remix-run/react-router/pull/9709))
522
523### Patch Changes
524
525- Fix `generatePath` when optional params are present ([#9764](https://github.com/remix-run/react-router/pull/9764))
526- Update `<Await>` to accept `ReactNode` as children function return result ([#9896](https://github.com/remix-run/react-router/pull/9896))
527- Updated dependencies:
528 - `@remix-run/router@1.3.0`
529
530## 6.6.2
531
532### Patch Changes
533
534- Ensure `useId` consistency during SSR ([#9805](https://github.com/remix-run/react-router/pull/9805))
535
536## 6.6.1
537
538### Patch Changes
539
540- Updated dependencies:
541 - `@remix-run/router@1.2.1`
542
543## 6.6.0
544
545### Patch Changes
546
547- Prevent `useLoaderData` usage in `errorElement` ([#9735](https://github.com/remix-run/react-router/pull/9735))
548- Updated dependencies:
549 - `@remix-run/router@1.2.0`
550
551## 6.5.0
552
553This 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.
554
555**Optional Params Examples**
556
557- `<Route path=":lang?/about>` will match:
558 - `/:lang/about`
559 - `/about`
560- `<Route path="/multistep/:widget1?/widget2?/widget3?">` will match:
561 - `/multistep`
562 - `/multistep/:widget1`
563 - `/multistep/:widget1/:widget2`
564 - `/multistep/:widget1/:widget2/:widget3`
565
566**Optional Static Segment Example**
567
568- `<Route path="/home?">` will match:
569 - `/`
570 - `/home`
571- `<Route path="/fr?/about">` will match:
572 - `/about`
573 - `/fr/about`
574
575### Minor Changes
576
577- Allows optional routes and optional static segments ([#9650](https://github.com/remix-run/react-router/pull/9650))
578
579### Patch Changes
580
581- 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))
582
583```jsx
584// Old behavior at URL /prefix-123
585<Route path="prefix-:id" element={<Comp /> }>
586
587function Comp() {
588 let params = useParams(); // { id: '123' }
589 let id = params.id; // "123"
590 ...
591}
592
593// New behavior at URL /prefix-123
594<Route path=":id" element={<Comp /> }>
595
596function Comp() {
597 let params = useParams(); // { id: 'prefix-123' }
598 let id = params.id.replace(/^prefix-/, ''); // "123"
599 ...
600}
601```
602
603- Updated dependencies:
604 - `@remix-run/router@1.1.0`
605
606## 6.4.5
607
608### Patch Changes
609
610- Updated dependencies:
611 - `@remix-run/router@1.0.5`
612
613## 6.4.4
614
615### Patch Changes
616
617- Updated dependencies:
618 - `@remix-run/router@1.0.4`
619
620## 6.4.3
621
622### Patch Changes
623
624- `useRoutes` should be able to return `null` when passing `locationArg` ([#9485](https://github.com/remix-run/react-router/pull/9485))
625- fix `initialEntries` type in `createMemoryRouter` ([#9498](https://github.com/remix-run/react-router/pull/9498))
626- Updated dependencies:
627 - `@remix-run/router@1.0.3`
628
629## 6.4.2
630
631### Patch Changes
632
633- Fix `IndexRouteObject` and `NonIndexRouteObject` types to make `hasErrorElement` optional ([#9394](https://github.com/remix-run/react-router/pull/9394))
634- Enhance console error messages for invalid usage of data router hooks ([#9311](https://github.com/remix-run/react-router/pull/9311))
635- 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))
636- Updated dependencies:
637 - `@remix-run/router@1.0.2`
638
639## 6.4.1
640
641### Patch Changes
642
643- Preserve state from `initialEntries` ([#9288](https://github.com/remix-run/react-router/pull/9288))
644- Updated dependencies:
645 - `@remix-run/router@1.0.1`
646
647## 6.4.0
648
649Whoa this is a big one! `6.4.0` brings all the data loading and mutation APIs over from Remix. Here's a quick high level overview, but it's recommended you go check out the [docs](https://reactrouter.com), especially the [feature overview](https://reactrouter.com/start/overview) and the [tutorial](https://reactrouter.com/start/tutorial).
650
651**New APIs**
652
653- Create your router with `createMemoryRouter`
654- Render your router with `<RouterProvider>`
655- Load data with a Route `loader` and mutate with a Route `action`
656- Handle errors with Route `errorElement`
657- Defer non-critical data with `defer` and `Await`
658
659**Bug Fixes**
660
661- Path resolution is now trailing slash agnostic (#8861)
662- `useLocation` returns the scoped location inside a `<Routes location>` component (#9094)
663
664**Updated Dependencies**
665
666- `@remix-run/router@1.0.0`