UNPKG

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