source: node_modules/react-router-dom/CHANGELOG.md

main
Last change on this file was d24f17c, checked in by Aleksandar Panovski <apano77@…>, 15 months ago

Initial commit

  • Property mode set to 100644
File size: 34.3 KB
Line 
1# `react-router-dom`
2
3## 6.22.1
4
5### Patch Changes
6
7- Updated dependencies:
8 - `react-router@6.22.1`
9 - `@remix-run/router@1.15.1`
10
11## 6.22.0
12
13### Minor Changes
14
15- Include a `window__reactRouterVersion` tag for CWV Report detection ([#11222](https://github.com/remix-run/react-router/pull/11222))
16
17### Patch Changes
18
19- Updated dependencies:
20 - `@remix-run/router@1.15.0`
21 - `react-router@6.22.0`
22
23## 6.21.3
24
25### Patch Changes
26
27- Fix `NavLink` `isPending` when a `basename` is used ([#11195](https://github.com/remix-run/react-router/pull/11195))
28- Remove leftover `unstable_` prefix from `Blocker`/`BlockerFunction` types ([#11187](https://github.com/remix-run/react-router/pull/11187))
29- Updated dependencies:
30 - `react-router@6.21.3`
31
32## 6.21.2
33
34### Patch Changes
35
36- Leverage `useId` for internal fetcher keys when available ([#11166](https://github.com/remix-run/react-router/pull/11166))
37- Updated dependencies:
38 - `@remix-run/router@1.14.2`
39 - `react-router@6.21.2`
40
41## 6.21.1
42
43### Patch Changes
44
45- Updated dependencies:
46 - `react-router@6.21.1`
47 - `@remix-run/router@1.14.1`
48
49## 6.21.0
50
51### Minor Changes
52
53- 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))
54
55 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))
56
57 **The Bug**
58 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.
59
60 **The Background**
61 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:
62
63 ```jsx
64 <BrowserRouter>
65 <Routes>
66 <Route path="/" element={<Home />} />
67 <Route path="dashboard/*" element={<Dashboard />} />
68 </Routes>
69 </BrowserRouter>
70 ```
71
72 Any paths like `/dashboard`, `/dashboard/team`, `/dashboard/projects` will match the `Dashboard` route. The dashboard component itself can then render nested `<Routes>`:
73
74 ```jsx
75 function Dashboard() {
76 return (
77 <div>
78 <h2>Dashboard</h2>
79 <nav>
80 <Link to="/">Dashboard Home</Link>
81 <Link to="team">Team</Link>
82 <Link to="projects">Projects</Link>
83 </nav>
84
85 <Routes>
86 <Route path="/" element={<DashboardHome />} />
87 <Route path="team" element={<DashboardTeam />} />
88 <Route path="projects" element={<DashboardProjects />} />
89 </Routes>
90 </div>
91 );
92 }
93 ```
94
95 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.
96
97 **The Problem**
98
99 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 `"."`:
100
101 ```jsx
102 // If we are on URL /dashboard/team, and we want to link to /dashboard/team:
103 function DashboardTeam() {
104 // ❌ This is broken and results in <a href="/dashboard">
105 return <Link to=".">A broken link to the Current URL</Link>;
106
107 // ✅ This is fixed but super unintuitive since we're already at /dashboard/team!
108 return <Link to="./team">A broken link to the Current URL</Link>;
109 }
110 ```
111
112 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.
113
114 Even worse, consider a nested splat route configuration:
115
116 ```jsx
117 <BrowserRouter>
118 <Routes>
119 <Route path="dashboard">
120 <Route path="*" element={<Dashboard />} />
121 </Route>
122 </Routes>
123 </BrowserRouter>
124 ```
125
126 Now, a `<Link to=".">` and a `<Link to="..">` inside the `Dashboard` component go to the same place! That is definitely not correct!
127
128 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:
129
130 ```jsx
131 let router = createBrowserRouter({
132 path: "/dashboard",
133 children: [
134 {
135 path: "*",
136 action: dashboardAction,
137 Component() {
138 // ❌ This form is broken! It throws a 405 error when it submits because
139 // it tries to submit to /dashboard (without the splat value) and the parent
140 // `/dashboard` route doesn't have an action
141 return <Form method="post">...</Form>;
142 },
143 },
144 ],
145 });
146 ```
147
148 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.
149
150 **The Solution**
151 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:
152
153 ```jsx
154 <BrowserRouter>
155 <Routes>
156 <Route path="dashboard">
157 <Route index path="*" element={<Dashboard />} />
158 </Route>
159 </Routes>
160 </BrowserRouter>
161
162 function Dashboard() {
163 return (
164 <div>
165 <h2>Dashboard</h2>
166 <nav>
167 <Link to="..">Dashboard Home</Link>
168 <Link to="../team">Team</Link>
169 <Link to="../projects">Projects</Link>
170 </nav>
171
172 <Routes>
173 <Route path="/" element={<DashboardHome />} />
174 <Route path="team" element={<DashboardTeam />} />
175 <Route path="projects" element={<DashboardProjects />} />
176 </Router>
177 </div>
178 );
179 }
180 ```
181
182 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".
183
184### Patch Changes
185
186- Updated dependencies:
187 - `@remix-run/router@1.14.0`
188 - `react-router@6.21.0`
189
190## 6.20.1
191
192### Patch Changes
193
194- 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))
195- Updated dependencies:
196 - `react-router@6.20.1`
197 - `@remix-run/router@1.13.1`
198
199## 6.20.0
200
201### Minor Changes
202
203- Export the `PathParam` type from the public API ([#10719](https://github.com/remix-run/react-router/pull/10719))
204
205### Patch Changes
206
207- Updated dependencies:
208 - `react-router@6.20.0`
209 - `@remix-run/router@1.13.0`
210
211## 6.19.0
212
213### Minor Changes
214
215- 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))
216- Allow `unstable_usePrompt` to accept a `BlockerFunction` in addition to a `boolean` ([#10991](https://github.com/remix-run/react-router/pull/10991))
217
218### Patch Changes
219
220- Fix issue where a changing fetcher `key` in a `useFetcher` that remains mounted wasn't getting picked up ([#11009](https://github.com/remix-run/react-router/pull/11009))
221- Fix `useFormAction` which was incorrectly inheriting the `?index` query param from child route `action` submissions ([#11025](https://github.com/remix-run/react-router/pull/11025))
222- Fix `NavLink` `active` logic when `to` location has a trailing slash ([#10734](https://github.com/remix-run/react-router/pull/10734))
223- Updated dependencies:
224 - `react-router@6.19.0`
225 - `@remix-run/router@1.12.0`
226
227## 6.18.0
228
229### Minor Changes
230
231- Add support for manual fetcher key specification via `useFetcher({ key: string })` so you can access the same fetcher instance from different components in your application without prop-drilling ([RFC](https://github.com/remix-run/remix/discussions/7698)) ([#10960](https://github.com/remix-run/react-router/pull/10960))
232
233 - Fetcher keys are now also exposed on the fetchers returned from `useFetchers` so that they can be looked up by `key`
234
235- Add `navigate`/`fetcherKey` params/props to `useSumbit`/`Form` to support kicking off a fetcher submission under the hood with an optionally user-specified `key` ([#10960](https://github.com/remix-run/react-router/pull/10960))
236
237 - Invoking a fetcher in this way is ephemeral and stateless
238 - If you need to access the state of one of these fetchers, you will need to leverage `useFetcher({ key })` to look it up elsewhere
239
240### Patch Changes
241
242- Adds a fetcher context to `RouterProvider` that holds completed fetcher data, in preparation for the upcoming future flag that will change the fetcher persistence/cleanup behavior ([#10961](https://github.com/remix-run/react-router/pull/10961))
243- 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))
244- Updated dependencies:
245 - `@remix-run/router@1.11.0`
246 - `react-router@6.18.0`
247
248## 6.17.0
249
250### Minor Changes
251
252- Add experimental support for the [View Transitions API](https://developer.mozilla.org/en-US/docs/Web/API/ViewTransition) via `document.startViewTransition` to enable CSS animated transitions on SPA navigations in your application. ([#10916](https://github.com/remix-run/react-router/pull/10916))
253
254 The simplest approach to enabling a View Transition in your React Router app is via the new `<Link unstable_viewTransition>` prop. This will cause the navigation DOM update to be wrapped in `document.startViewTransition` which will enable transitions for the DOM update. Without any additional CSS styles, you'll get a basic cross-fade animation for your page.
255
256 If you need to apply more fine-grained styles for your animations, you can leverage the `unstable_useViewTransitionState` hook which will tell you when a transition is in progress and you can use that to apply classes or styles:
257
258 ```jsx
259 function ImageLink(to, src, alt) {
260 let isTransitioning = unstable_useViewTransitionState(to);
261 return (
262 <Link to={to} unstable_viewTransition>
263 <img
264 src={src}
265 alt={alt}
266 style={{
267 viewTransitionName: isTransitioning ? "image-expand" : "",
268 }}
269 />
270 </Link>
271 );
272 }
273 ```
274
275 You can also use the `<NavLink unstable_viewTransition>` shorthand which will manage the hook usage for you and automatically add a `transitioning` class to the `<a>` during the transition:
276
277 ```css
278 a.transitioning img {
279 view-transition-name: "image-expand";
280 }
281 ```
282
283 ```jsx
284 <NavLink to={to} unstable_viewTransition>
285 <img src={src} alt={alt} />
286 </NavLink>
287 ```
288
289 For an example usage of View Transitions with React Router, check out [our fork](https://github.com/brophdawg11/react-router-records) of the [Astro Records](https://github.com/Charca/astro-records) demo.
290
291 For more information on using the View Transitions API, please refer to the [Smooth and simple transitions with the View Transitions API](https://developer.chrome.com/docs/web-platform/view-transitions/) guide from the Google Chrome team.
292
293 Please note, that because the `ViewTransition` API is a DOM API, we now export a specific `RouterProvider` from `react-router-dom` with this functionality. If you are importing `RouterProvider` from `react-router`, then it will not support view transitions. ([#10928](https://github.com/remix-run/react-router/pull/10928)
294
295### Patch Changes
296
297- Log a warning and fail gracefully in `ScrollRestoration` when `sessionStorage` is unavailable ([#10848](https://github.com/remix-run/react-router/pull/10848))
298- Updated dependencies:
299 - `@remix-run/router@1.10.0`
300 - `react-router@6.17.0`
301
302## 6.16.0
303
304### Minor Changes
305
306- Updated dependencies:
307 - `@remix-run/router@1.9.0`
308 - `react-router@6.16.0`
309
310### Patch Changes
311
312- Properly encode rendered URIs in server rendering to avoid hydration errors ([#10769](https://github.com/remix-run/react-router/pull/10769))
313
314## 6.15.0
315
316### Minor Changes
317
318- 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))
319
320### Patch Changes
321
322- Fixes an edge-case affecting web extensions in Firefox that use `URLSearchParams` and the `useSearchParams` hook. ([#10620](https://github.com/remix-run/react-router/pull/10620))
323- Do not include hash in `useFormAction()` for unspecified actions since it cannot be determined on the server and causes hydration issues ([#10758](https://github.com/remix-run/react-router/pull/10758))
324- Reorder effects in `unstable_usePrompt` to avoid throwing an exception if the prompt is unblocked and a navigation is performed synchronously ([#10687](https://github.com/remix-run/react-router/pull/10687), [#10718](https://github.com/remix-run/react-router/pull/10718))
325- Updated dependencies:
326 - `@remix-run/router@1.8.0`
327 - `react-router@6.15.0`
328
329## 6.14.2
330
331### Patch Changes
332
333- Properly decode element id when emulating hash scrolling via `<ScrollRestoration>` ([#10682](https://github.com/remix-run/react-router/pull/10682))
334- Add missing `<Form state>` prop to populate `history.state` on submission navigations ([#10630](https://github.com/remix-run/react-router/pull/10630))
335- Support proper hydration of `Error` subclasses such as `ReferenceError`/`TypeError` ([#10633](https://github.com/remix-run/react-router/pull/10633))
336- Updated dependencies:
337 - `@remix-run/router@1.7.2`
338 - `react-router@6.14.2`
339
340## 6.14.1
341
342### Patch Changes
343
344- Updated dependencies:
345 - `react-router@6.14.1`
346 - `@remix-run/router@1.7.1`
347
348## 6.14.0
349
350### Minor Changes
351
352- Add support for `application/json` and `text/plain` encodings for `useSubmit`/`fetcher.submit`. To reflect these additional types, `useNavigation`/`useFetcher` now also contain `navigation.json`/`navigation.text` and `fetcher.json`/`fetcher.text` which include the json/text submission if applicable ([#10413](https://github.com/remix-run/react-router/pull/10413))
353
354 ```jsx
355 // The default behavior will still serialize as FormData
356 function Component() {
357 let navigation = useNavigation();
358 let submit = useSubmit();
359 submit({ key: "value" }, { method: "post" });
360 // navigation.formEncType => "application/x-www-form-urlencoded"
361 // navigation.formData => FormData instance
362 }
363
364 async function action({ request }) {
365 // request.headers.get("Content-Type") => "application/x-www-form-urlencoded"
366 // await request.formData() => FormData instance
367 }
368 ```
369
370 ```js
371 // Opt-into JSON encoding with `encType: "application/json"`
372 function Component() {
373 let navigation = useNavigation();
374 let submit = useSubmit();
375 submit({ key: "value" }, { method: "post", encType: "application/json" });
376 // navigation.formEncType => "application/json"
377 // navigation.json => { key: "value" }
378 }
379
380 async function action({ request }) {
381 // request.headers.get("Content-Type") => "application/json"
382 // await request.json() => { key: "value" }
383 }
384 ```
385
386 ```js
387 // Opt-into text encoding with `encType: "text/plain"`
388 function Component() {
389 let navigation = useNavigation();
390 let submit = useSubmit();
391 submit("Text submission", { method: "post", encType: "text/plain" });
392 // navigation.formEncType => "text/plain"
393 // navigation.text => "Text submission"
394 }
395
396 async function action({ request }) {
397 // request.headers.get("Content-Type") => "text/plain"
398 // await request.text() => "Text submission"
399 }
400 ```
401
402### Patch Changes
403
404- When submitting a form from a `submitter` element, prefer the built-in `new FormData(form, submitter)` instead of the previous manual approach in modern browsers (those that support the new `submitter` parameter) ([#9865](https://github.com/remix-run/react-router/pull/9865), [#10627](https://github.com/remix-run/react-router/pull/10627))
405 - For browsers that don't support it, we continue to just append the submit button's entry to the end, and we also add rudimentary support for `type="image"` buttons
406 - If developers want full spec-compliant support for legacy browsers, they can use the `formdata-submitter-polyfill`
407- Call `window.history.pushState/replaceState` before updating React Router state (instead of after) so that `window.location` matches `useLocation` during synchronous React 17 rendering ([#10448](https://github.com/remix-run/react-router/pull/10448))
408 - ⚠️ However, generally apps should not be relying on `window.location` and should always reference `useLocation` when possible, as `window.location` will not be in sync 100% of the time (due to `popstate` events, concurrent mode, etc.)
409- Fix `tsc --skipLibCheck:false` issues on React 17 ([#10622](https://github.com/remix-run/react-router/pull/10622))
410- Upgrade `typescript` to 5.1 ([#10581](https://github.com/remix-run/react-router/pull/10581))
411- Updated dependencies:
412 - `react-router@6.14.0`
413 - `@remix-run/router@1.7.0`
414
415## 6.13.0
416
417### Minor Changes
418
419- 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))
420
421 Existing behavior will no longer include `React.startTransition`:
422
423 ```jsx
424 <BrowserRouter>
425 <Routes>{/*...*/}</Routes>
426 </BrowserRouter>
427
428 <RouterProvider router={router} />
429 ```
430
431 If you wish to enable `React.startTransition`, pass the future flag to your component:
432
433 ```jsx
434 <BrowserRouter future={{ v7_startTransition: true }}>
435 <Routes>{/*...*/}</Routes>
436 </BrowserRouter>
437
438 <RouterProvider router={router} future={{ v7_startTransition: true }}/>
439 ```
440
441### Patch Changes
442
443- Work around webpack/terser `React.startTransition` minification bug in production mode ([#10588](https://github.com/remix-run/react-router/pull/10588))
444- Updated dependencies:
445 - `react-router@6.13.0`
446
447## 6.12.1
448
449> \[!WARNING]
450> 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.
451
452### Patch Changes
453
454- Adjust feature detection of `React.startTransition` to fix webpack + react 17 compilation error ([#10569](https://github.com/remix-run/react-router/pull/10569))
455- Updated dependencies:
456 - `react-router@6.12.1`
457
458## 6.12.0
459
460### Minor Changes
461
462- Wrap internal router state updates with `React.startTransition` if it exists ([#10438](https://github.com/remix-run/react-router/pull/10438))
463
464### Patch Changes
465
466- Re-throw `DOMException` (`DataCloneError`) when attempting to perform a `PUSH` navigation with non-serializable state. ([#10427](https://github.com/remix-run/react-router/pull/10427))
467- Updated dependencies:
468 - `@remix-run/router@1.6.3`
469 - `react-router@6.12.0`
470
471## 6.11.2
472
473### Patch Changes
474
475- Export `SetURLSearchParams` type ([#10444](https://github.com/remix-run/react-router/pull/10444))
476- Updated dependencies:
477 - `react-router@6.11.2`
478 - `@remix-run/router@1.6.2`
479
480## 6.11.1
481
482### Patch Changes
483
484- Updated dependencies:
485 - `react-router@6.11.1`
486 - `@remix-run/router@1.6.1`
487
488## 6.11.0
489
490### Minor Changes
491
492- Enable `basename` support in `useFetcher` ([#10336](https://github.com/remix-run/react-router/pull/10336))
493 - If you were previously working around this issue by manually prepending the `basename` then you will need to remove the manually prepended `basename` from your `fetcher` calls (`fetcher.load('/basename/route') -> fetcher.load('/route')`)
494
495### Patch Changes
496
497- Fix inadvertent re-renders when using `Component` instead of `element` on a route definition ([#10287](https://github.com/remix-run/react-router/pull/10287))
498- Fail gracefully on `<Link to="//">` and other invalid URL values ([#10367](https://github.com/remix-run/react-router/pull/10367))
499- 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))
500- Add static prop to `StaticRouterProvider`'s internal `Router` component ([#10401](https://github.com/remix-run/react-router/pull/10401))
501- 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))
502- Updated dependencies:
503 - `react-router@6.11.0`
504 - `@remix-run/router@1.6.0`
505
506## 6.10.0
507
508### Minor Changes
509
510- 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))
511
512 - When `future.v7_normalizeFormMethod === false` (default v6 behavior),
513 - `useNavigation().formMethod` is lowercase
514 - `useFetcher().formMethod` is lowercase
515 - When `future.v7_normalizeFormMethod === true`:
516 - `useNavigation().formMethod` is uppercase
517 - `useFetcher().formMethod` is uppercase
518
519### Patch Changes
520
521- Fix `createStaticHandler` to also check for `ErrorBoundary` on routes in addition to `errorElement` ([#10190](https://github.com/remix-run/react-router/pull/10190))
522- Updated dependencies:
523 - `@remix-run/router@1.5.0`
524 - `react-router@6.10.0`
525
526## 6.9.0
527
528### Minor Changes
529
530- 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))
531
532 **Example JSON Syntax**
533
534 ```jsx
535 // Both of these work the same:
536 const elementRoutes = [{
537 path: '/',
538 element: <Home />,
539 errorElement: <HomeError />,
540 }]
541
542 const componentRoutes = [{
543 path: '/',
544 Component: Home,
545 ErrorBoundary: HomeError,
546 }]
547
548 function Home() { ... }
549 function HomeError() { ... }
550 ```
551
552 **Example JSX Syntax**
553
554 ```jsx
555 // Both of these work the same:
556 const elementRoutes = createRoutesFromElements(
557 <Route path='/' element={<Home />} errorElement={<HomeError /> } />
558 );
559
560 const componentRoutes = createRoutesFromElements(
561 <Route path='/' Component={Home} ErrorBoundary={HomeError} />
562 );
563
564 function Home() { ... }
565 function HomeError() { ... }
566 ```
567
568- **Introducing Lazy Route Modules!** ([#10045](https://github.com/remix-run/react-router/pull/10045))
569
570 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`).
571
572 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.
573
574 Your `lazy` functions will typically return the result of a dynamic import.
575
576 ```jsx
577 // In this example, we assume most folks land on the homepage so we include that
578 // in our critical-path bundle, but then we lazily load modules for /a and /b so
579 // they don't load until the user navigates to those routes
580 let routes = createRoutesFromElements(
581 <Route path="/" element={<Layout />}>
582 <Route index element={<Home />} />
583 <Route path="a" lazy={() => import("./a")} />
584 <Route path="b" lazy={() => import("./b")} />
585 </Route>
586 );
587 ```
588
589 Then in your lazy route modules, export the properties you want defined for the route:
590
591 ```jsx
592 export async function loader({ request }) {
593 let data = await fetchData(request);
594 return json(data);
595 }
596
597 // Export a `Component` directly instead of needing to create a React Element from it
598 export function Component() {
599 let data = useLoaderData();
600
601 return (
602 <>
603 <h1>You made it!</h1>
604 <p>{data}</p>
605 </>
606 );
607 }
608
609 // Export an `ErrorBoundary` directly instead of needing to create a React Element from it
610 export function ErrorBoundary() {
611 let error = useRouteError();
612 return isRouteErrorResponse(error) ? (
613 <h1>
614 {error.status} {error.statusText}
615 </h1>
616 ) : (
617 <h1>{error.message || error}</h1>
618 );
619 }
620 ```
621
622 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.
623
624 🙌 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).
625
626- Updated dependencies:
627 - `react-router@6.9.0`
628 - `@remix-run/router@1.4.0`
629
630## 6.8.2
631
632### Patch Changes
633
634- Treat same-origin absolute URLs in `<Link to>` as external if they are outside of the router `basename` ([#10135](https://github.com/remix-run/react-router/pull/10135))
635- Fix `useBlocker` to return `IDLE_BLOCKER` during SSR ([#10046](https://github.com/remix-run/react-router/pull/10046))
636- Fix SSR of absolute `<Link to>` urls ([#10112](https://github.com/remix-run/react-router/pull/10112))
637- Properly escape HTML characters in `StaticRouterProvider` serialized hydration data ([#10068](https://github.com/remix-run/react-router/pull/10068))
638- Updated dependencies:
639 - `@remix-run/router@1.3.3`
640 - `react-router@6.8.2`
641
642## 6.8.1
643
644### Patch Changes
645
646- Improved absolute url detection in `Link` component (now also supports `mailto:` urls) ([#9994](https://github.com/remix-run/react-router/pull/9994))
647- Fix partial object (search or hash only) pathnames losing current path value ([#10029](https://github.com/remix-run/react-router/pull/10029))
648- Updated dependencies:
649 - `react-router@6.8.1`
650 - `@remix-run/router@1.3.2`
651
652## 6.8.0
653
654### Minor Changes
655
656- Support absolute URLs in `<Link to>`. If the URL is for the current origin, it will still do a client-side navigation. If the URL is for a different origin then it will do a fresh document request for the new origin. ([#9900](https://github.com/remix-run/react-router/pull/9900))
657
658 ```tsx
659 <Link to="https://neworigin.com/some/path"> {/* Document request */}
660 <Link to="//neworigin.com/some/path"> {/* Document request */}
661 <Link to="https://www.currentorigin.com/path"> {/* Client-side navigation */}
662 ```
663
664### Patch Changes
665
666- Fix bug with search params removal via `useSearchParams` ([#9969](https://github.com/remix-run/react-router/pull/9969))
667- Respect `preventScrollReset` on `<fetcher.Form>` ([#9963](https://github.com/remix-run/react-router/pull/9963))
668- Fix navigation for hash routers on manual URL changes ([#9980](https://github.com/remix-run/react-router/pull/9980))
669- Use `pagehide` instead of `beforeunload` for `<ScrollRestoration>`. This has better cross-browser support, specifically on Mobile Safari. ([#9945](https://github.com/remix-run/react-router/pull/9945))
670- Updated dependencies:
671 - `@remix-run/router@1.3.1`
672 - `react-router@6.8.0`
673
674## 6.7.0
675
676### Minor Changes
677
678- Add `unstable_useBlocker` hook for blocking navigations within the app's location origin ([#9709](https://github.com/remix-run/react-router/pull/9709))
679- Add `unstable_usePrompt` hook for blocking navigations within the app's location origin ([#9932](https://github.com/remix-run/react-router/pull/9932))
680- Add `preventScrollReset` prop to `<Form>` ([#9886](https://github.com/remix-run/react-router/pull/9886))
681
682### Patch Changes
683
684- Added pass-through event listener options argument to `useBeforeUnload` ([#9709](https://github.com/remix-run/react-router/pull/9709))
685- Streamline jsdom bug workaround in tests ([#9824](https://github.com/remix-run/react-router/pull/9824))
686- Updated dependencies:
687 - `@remix-run/router@1.3.0`
688 - `react-router@6.7.0`
689
690## 6.6.2
691
692### Patch Changes
693
694- Ensure `useId` consistency during SSR ([#9805](https://github.com/remix-run/react-router/pull/9805))
695- Updated dependencies:
696 - `react-router@6.6.2`
697
698## 6.6.1
699
700### Patch Changes
701
702- Updated dependencies:
703 - `@remix-run/router@1.2.1`
704 - `react-router@6.6.1`
705
706## 6.6.0
707
708### Minor Changes
709
710- Add `useBeforeUnload()` hook ([#9664](https://github.com/remix-run/react-router/pull/9664))
711- Remove `unstable_` prefix from `createStaticHandler`/`createStaticRouter`/`StaticRouterProvider` ([#9738](https://github.com/remix-run/react-router/pull/9738))
712
713### Patch Changes
714
715- Proper hydration of `Error` objects from `StaticRouterProvider` ([#9664](https://github.com/remix-run/react-router/pull/9664))
716- Support uppercase `<Form method>` and `useSubmit` method values ([#9664](https://github.com/remix-run/react-router/pull/9664))
717- Skip initial scroll restoration for SSR apps with `hydrationData` ([#9664](https://github.com/remix-run/react-router/pull/9664))
718- Fix `<button formmethod>` form submission overriddes ([#9664](https://github.com/remix-run/react-router/pull/9664))
719- Updated dependencies:
720 - `@remix-run/router@1.2.0`
721 - `react-router@6.6.0`
722
723## 6.5.0
724
725### Patch Changes
726
727- Updated dependencies:
728 - `react-router@6.5.0`
729 - `@remix-run/router@1.1.0`
730
731## 6.4.5
732
733### Patch Changes
734
735- Updated dependencies:
736 - `@remix-run/router@1.0.5`
737 - `react-router@6.4.5`
738
739## 6.4.4
740
741### Patch Changes
742
743- Fix issues with encoded characters in `NavLink` and descendant `<Routes>` ([#9589](https://github.com/remix-run/react-router/pull/9589), [#9647](https://github.com/remix-run/react-router/pull/9647))
744- Properly serialize/deserialize `ErrorResponse` instances when using built-in hydration ([#9593](https://github.com/remix-run/react-router/pull/9593))
745- Support `basename` in static data routers ([#9591](https://github.com/remix-run/react-router/pull/9591))
746- Updated dependencies:
747 - `@remix-run/router@1.0.4`
748 - `react-router@6.4.4`
749
750## 6.4.3
751
752### Patch Changes
753
754- Fix hrefs generated for `createHashRouter` ([#9409](https://github.com/remix-run/react-router/pull/9409))
755- fix encoding/matching issues with special chars ([#9477](https://github.com/remix-run/react-router/pull/9477), [#9496](https://github.com/remix-run/react-router/pull/9496))
756- Properly support `index` routes with a `path` in `useResolvedPath` ([#9486](https://github.com/remix-run/react-router/pull/9486))
757- Respect `relative=path` prop on `NavLink` ([#9453](https://github.com/remix-run/react-router/pull/9453))
758- Fix `NavLink` behavior for root urls ([#9497](https://github.com/remix-run/react-router/pull/9497))
759- Updated dependencies:
760 - `@remix-run/router@1.0.3`
761 - `react-router@6.4.3`
762
763## 6.4.2
764
765### Patch Changes
766
767- Respect `basename` in `useFormAction` ([#9352](https://github.com/remix-run/react-router/pull/9352))
768- Enhance console error messages for invalid usage of data router hooks ([#9311](https://github.com/remix-run/react-router/pull/9311))
769- 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))
770- Updated dependencies:
771 - `react-router@6.4.2`
772 - `@remix-run/router@1.0.2`
773
774## 6.4.1
775
776### Patch Changes
777
778- Updated dependencies:
779 - `react-router@6.4.1`
780 - `@remix-run/router@1.0.1`
781
782## 6.4.0
783
784Whoa 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).
785
786**New APIs**
787
788- Create your router with `createMemoryRouter`/`createBrowserRouter`/`createHashRouter`
789- Render your router with `<RouterProvider>`
790- Load data with a Route `loader` and mutate with a Route `action`
791- Handle errors with Route `errorElement`
792- Submit data with the new `<Form>` component
793- Perform in-page data loads and mutations with `useFetcher()`
794- Defer non-critical data with `defer` and `Await`
795- Manage scroll position with `<ScrollRestoration>`
796
797**New Features**
798
799- Perform path-relative navigations with `<Link relative="path">` (#9160)
800
801**Bug Fixes**
802
803- Path resolution is now trailing slash agnostic (#8861)
804- `useLocation` returns the scoped location inside a `<Routes location>` component (#9094)
805- respect the `<Link replace>` prop if it is defined (#8779)
806
807**Updated Dependencies**
808
809- `react-router@6.4.0`
Note: See TracBrowser for help on using the repository browser.