react-router-dom 6.27.0 → 7.0.0-pre.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md DELETED
@@ -1,950 +0,0 @@
1
- # `react-router-dom`
2
-
3
- ## 6.27.0
4
-
5
- ### Minor Changes
6
-
7
- - Stabilize `unstable_patchRoutesOnNavigation` ([#11973](https://github.com/remix-run/react-router/pull/11973))
8
- - Add new `PatchRoutesOnNavigationFunctionArgs` type for convenience ([#11967](https://github.com/remix-run/react-router/pull/11967))
9
- - Stabilize `unstable_dataStrategy` ([#11974](https://github.com/remix-run/react-router/pull/11974))
10
- - Stabilize the `unstable_flushSync` option for navigations and fetchers ([#11989](https://github.com/remix-run/react-router/pull/11989))
11
- - Stabilize the `unstable_viewTransition` option for navigations and the corresponding `unstable_useViewTransitionState` hook ([#11989](https://github.com/remix-run/react-router/pull/11989))
12
-
13
- ### Patch Changes
14
-
15
- - Fix bug when submitting to the current contextual route (parent route with an index child) when an `?index` param already exists from a prior submission ([#12003](https://github.com/remix-run/react-router/pull/12003))
16
- - Fix `useFormAction` bug - when removing `?index` param it would not keep other non-Remix `index` params ([#12003](https://github.com/remix-run/react-router/pull/12003))
17
- - Fix types for `RouteObject` within `PatchRoutesOnNavigationFunction`'s `patch` method so it doesn't expect agnostic route objects passed to `patch` ([#11967](https://github.com/remix-run/react-router/pull/11967))
18
-
19
- - Updated dependencies:
20
- - `react-router@6.27.0`
21
- - `@remix-run/router@1.20.0`
22
-
23
- ## 6.26.2
24
-
25
- ### Patch Changes
26
-
27
- - Updated dependencies:
28
- - `@remix-run/router@1.19.2`
29
- - `react-router@6.26.2`
30
-
31
- ## 6.26.1
32
-
33
- ### Patch Changes
34
-
35
- - Rename `unstable_patchRoutesOnMiss` to `unstable_patchRoutesOnNavigation` to match new behavior ([#11888](https://github.com/remix-run/react-router/pull/11888))
36
- - Updated dependencies:
37
- - `@remix-run/router@1.19.1`
38
- - `react-router@6.26.1`
39
-
40
- ## 6.26.0
41
-
42
- ### Minor Changes
43
-
44
- - Add a new `replace(url, init?)` alternative to `redirect(url, init?)` that performs a `history.replaceState` instead of a `history.pushState` on client-side navigation redirects ([#11811](https://github.com/remix-run/react-router/pull/11811))
45
-
46
- ### Patch Changes
47
-
48
- - Fix initial hydration behavior when using `future.v7_partialHydration` along with `unstable_patchRoutesOnMiss` ([#11838](https://github.com/remix-run/react-router/pull/11838))
49
- - During initial hydration, `router.state.matches` will now include any partial matches so that we can render ancestor `HydrateFallback` components
50
- - Updated dependencies:
51
- - `@remix-run/router@1.19.0`
52
- - `react-router@6.26.0`
53
-
54
- ## 6.25.1
55
-
56
- ### Patch Changes
57
-
58
- - Memoize some `RouterProvider` internals to reduce unnecessary re-renders ([#11803](https://github.com/remix-run/react-router/pull/11803))
59
- - Updated dependencies:
60
- - `react-router@6.25.1`
61
-
62
- ## 6.25.0
63
-
64
- ### Minor Changes
65
-
66
- - Stabilize `future.unstable_skipActionErrorRevalidation` as `future.v7_skipActionErrorRevalidation` ([#11769](https://github.com/remix-run/react-router/pull/11769))
67
- - When this flag is enabled, actions will not automatically trigger a revalidation if they return/throw a `Response` with a `4xx`/`5xx` status code
68
- - You may still opt-into revalidation via `shouldRevalidate`
69
- - This also changes `shouldRevalidate`'s `unstable_actionStatus` parameter to `actionStatus`
70
-
71
- ### Patch Changes
72
-
73
- - Updated dependencies:
74
- - `react-router@6.25.0`
75
- - `@remix-run/router@1.18.0`
76
-
77
- ## 6.24.1
78
-
79
- ### Patch Changes
80
-
81
- - Remove `polyfill.io` reference from warning message because the domain was sold and has since been determined to serve malware ([#11741](https://github.com/remix-run/react-router/pull/11741))
82
- - See <https://sansec.io/research/polyfill-supply-chain-attack>
83
- - Export `NavLinkRenderProps` type for easier typing of custom `NavLink` callback ([#11553](https://github.com/remix-run/react-router/pull/11553))
84
- - Updated dependencies:
85
- - `@remix-run/router@1.17.1`
86
- - `react-router@6.24.1`
87
-
88
- ## 6.24.0
89
-
90
- ### Minor Changes
91
-
92
- - Add support for Lazy Route Discovery (a.k.a. Fog of War) ([#11626](https://github.com/remix-run/react-router/pull/11626))
93
- - RFC: <https://github.com/remix-run/react-router/discussions/11113>
94
- - `unstable_patchRoutesOnMiss` docs: <https://reactrouter.com/en/main/routers/create-browser-router>
95
-
96
- ### Patch Changes
97
-
98
- - Fix `fetcher.submit` types - remove incorrect `navigate`/`fetcherKey`/`unstable_viewTransition` options because they are only relevant for `useSubmit` ([#11631](https://github.com/remix-run/react-router/pull/11631))
99
- - Allow falsy `location.state` values passed to `<StaticRouter>` ([#11495](https://github.com/remix-run/react-router/pull/11495))
100
- - Updated dependencies:
101
- - `react-router@6.24.0`
102
- - `@remix-run/router@1.17.0`
103
-
104
- ## 6.23.1
105
-
106
- ### Patch Changes
107
-
108
- - Check for `document` existence when checking `startViewTransition` ([#11544](https://github.com/remix-run/react-router/pull/11544))
109
- - Change the `react-router-dom/server` import back to `react-router-dom` instead of `index.ts` ([#11514](https://github.com/remix-run/react-router/pull/11514))
110
- - Updated dependencies:
111
- - `@remix-run/router@1.16.1`
112
- - `react-router@6.23.1`
113
-
114
- ## 6.23.0
115
-
116
- ### Minor Changes
117
-
118
- - Add a new `unstable_dataStrategy` configuration option ([#11098](https://github.com/remix-run/react-router/pull/11098))
119
- - This option allows Data Router applications to take control over the approach for executing route loaders and actions
120
- - The default implementation is today's behavior, to fetch all loaders in parallel, but this option allows users to implement more advanced data flows including Remix single-fetch, middleware/context APIs, automatic loader caching, and more
121
-
122
- ### Patch Changes
123
-
124
- - Updated dependencies:
125
- - `@remix-run/router@1.16.0`
126
- - `react-router@6.23.0`
127
-
128
- ## 6.22.3
129
-
130
- ### Patch Changes
131
-
132
- - Updated dependencies:
133
- - `@remix-run/router@1.15.3`
134
- - `react-router@6.22.3`
135
-
136
- ## 6.22.2
137
-
138
- ### Patch Changes
139
-
140
- - Updated dependencies:
141
- - `@remix-run/router@1.15.2`
142
- - `react-router@6.22.2`
143
-
144
- ## 6.22.1
145
-
146
- ### Patch Changes
147
-
148
- - Updated dependencies:
149
- - `react-router@6.22.1`
150
- - `@remix-run/router@1.15.1`
151
-
152
- ## 6.22.0
153
-
154
- ### Minor Changes
155
-
156
- - Include a `window__reactRouterVersion` tag for CWV Report detection ([#11222](https://github.com/remix-run/react-router/pull/11222))
157
-
158
- ### Patch Changes
159
-
160
- - Updated dependencies:
161
- - `@remix-run/router@1.15.0`
162
- - `react-router@6.22.0`
163
-
164
- ## 6.21.3
165
-
166
- ### Patch Changes
167
-
168
- - Fix `NavLink` `isPending` when a `basename` is used ([#11195](https://github.com/remix-run/react-router/pull/11195))
169
- - Remove leftover `unstable_` prefix from `Blocker`/`BlockerFunction` types ([#11187](https://github.com/remix-run/react-router/pull/11187))
170
- - Updated dependencies:
171
- - `react-router@6.21.3`
172
-
173
- ## 6.21.2
174
-
175
- ### Patch Changes
176
-
177
- - Leverage `useId` for internal fetcher keys when available ([#11166](https://github.com/remix-run/react-router/pull/11166))
178
- - Updated dependencies:
179
- - `@remix-run/router@1.14.2`
180
- - `react-router@6.21.2`
181
-
182
- ## 6.21.1
183
-
184
- ### Patch Changes
185
-
186
- - Updated dependencies:
187
- - `react-router@6.21.1`
188
- - `@remix-run/router@1.14.1`
189
-
190
- ## 6.21.0
191
-
192
- ### Minor Changes
193
-
194
- - 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))
195
-
196
- 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))
197
-
198
- **The Bug**
199
- 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.
200
-
201
- **The Background**
202
- 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:
203
-
204
- ```jsx
205
- <BrowserRouter>
206
- <Routes>
207
- <Route path="/" element={<Home />} />
208
- <Route path="dashboard/*" element={<Dashboard />} />
209
- </Routes>
210
- </BrowserRouter>
211
- ```
212
-
213
- Any paths like `/dashboard`, `/dashboard/team`, `/dashboard/projects` will match the `Dashboard` route. The dashboard component itself can then render nested `<Routes>`:
214
-
215
- ```jsx
216
- function Dashboard() {
217
- return (
218
- <div>
219
- <h2>Dashboard</h2>
220
- <nav>
221
- <Link to="/">Dashboard Home</Link>
222
- <Link to="team">Team</Link>
223
- <Link to="projects">Projects</Link>
224
- </nav>
225
-
226
- <Routes>
227
- <Route path="/" element={<DashboardHome />} />
228
- <Route path="team" element={<DashboardTeam />} />
229
- <Route path="projects" element={<DashboardProjects />} />
230
- </Routes>
231
- </div>
232
- );
233
- }
234
- ```
235
-
236
- 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.
237
-
238
- **The Problem**
239
-
240
- 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 `"."`:
241
-
242
- ```jsx
243
- // If we are on URL /dashboard/team, and we want to link to /dashboard/team:
244
- function DashboardTeam() {
245
- // ❌ This is broken and results in <a href="/dashboard">
246
- return <Link to=".">A broken link to the Current URL</Link>;
247
-
248
- // ✅ This is fixed but super unintuitive since we're already at /dashboard/team!
249
- return <Link to="./team">A broken link to the Current URL</Link>;
250
- }
251
- ```
252
-
253
- 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.
254
-
255
- Even worse, consider a nested splat route configuration:
256
-
257
- ```jsx
258
- <BrowserRouter>
259
- <Routes>
260
- <Route path="dashboard">
261
- <Route path="*" element={<Dashboard />} />
262
- </Route>
263
- </Routes>
264
- </BrowserRouter>
265
- ```
266
-
267
- Now, a `<Link to=".">` and a `<Link to="..">` inside the `Dashboard` component go to the same place! That is definitely not correct!
268
-
269
- 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:
270
-
271
- ```jsx
272
- let router = createBrowserRouter({
273
- path: "/dashboard",
274
- children: [
275
- {
276
- path: "*",
277
- action: dashboardAction,
278
- Component() {
279
- // ❌ This form is broken! It throws a 405 error when it submits because
280
- // it tries to submit to /dashboard (without the splat value) and the parent
281
- // `/dashboard` route doesn't have an action
282
- return <Form method="post">...</Form>;
283
- },
284
- },
285
- ],
286
- });
287
- ```
288
-
289
- 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.
290
-
291
- **The Solution**
292
- 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:
293
-
294
- ```jsx
295
- <BrowserRouter>
296
- <Routes>
297
- <Route path="dashboard">
298
- <Route index path="*" element={<Dashboard />} />
299
- </Route>
300
- </Routes>
301
- </BrowserRouter>
302
-
303
- function Dashboard() {
304
- return (
305
- <div>
306
- <h2>Dashboard</h2>
307
- <nav>
308
- <Link to="..">Dashboard Home</Link>
309
- <Link to="../team">Team</Link>
310
- <Link to="../projects">Projects</Link>
311
- </nav>
312
-
313
- <Routes>
314
- <Route path="/" element={<DashboardHome />} />
315
- <Route path="team" element={<DashboardTeam />} />
316
- <Route path="projects" element={<DashboardProjects />} />
317
- </Router>
318
- </div>
319
- );
320
- }
321
- ```
322
-
323
- 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".
324
-
325
- ### Patch Changes
326
-
327
- - Updated dependencies:
328
- - `@remix-run/router@1.14.0`
329
- - `react-router@6.21.0`
330
-
331
- ## 6.20.1
332
-
333
- ### Patch Changes
334
-
335
- - 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))
336
- - Updated dependencies:
337
- - `react-router@6.20.1`
338
- - `@remix-run/router@1.13.1`
339
-
340
- ## 6.20.0
341
-
342
- ### Minor Changes
343
-
344
- - Export the `PathParam` type from the public API ([#10719](https://github.com/remix-run/react-router/pull/10719))
345
-
346
- ### Patch Changes
347
-
348
- - Updated dependencies:
349
- - `react-router@6.20.0`
350
- - `@remix-run/router@1.13.0`
351
-
352
- ## 6.19.0
353
-
354
- ### Minor Changes
355
-
356
- - 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))
357
- - Allow `unstable_usePrompt` to accept a `BlockerFunction` in addition to a `boolean` ([#10991](https://github.com/remix-run/react-router/pull/10991))
358
-
359
- ### Patch Changes
360
-
361
- - 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))
362
- - 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))
363
- - Fix `NavLink` `active` logic when `to` location has a trailing slash ([#10734](https://github.com/remix-run/react-router/pull/10734))
364
- - Updated dependencies:
365
- - `react-router@6.19.0`
366
- - `@remix-run/router@1.12.0`
367
-
368
- ## 6.18.0
369
-
370
- ### Minor Changes
371
-
372
- - 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))
373
-
374
- - Fetcher keys are now also exposed on the fetchers returned from `useFetchers` so that they can be looked up by `key`
375
-
376
- - 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))
377
-
378
- - Invoking a fetcher in this way is ephemeral and stateless
379
- - If you need to access the state of one of these fetchers, you will need to leverage `useFetcher({ key })` to look it up elsewhere
380
-
381
- ### Patch Changes
382
-
383
- - 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))
384
- - 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))
385
- - Updated dependencies:
386
- - `@remix-run/router@1.11.0`
387
- - `react-router@6.18.0`
388
-
389
- ## 6.17.0
390
-
391
- ### Minor Changes
392
-
393
- - 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))
394
-
395
- 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.
396
-
397
- 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:
398
-
399
- ```jsx
400
- function ImageLink(to, src, alt) {
401
- let isTransitioning = unstable_useViewTransitionState(to);
402
- return (
403
- <Link to={to} unstable_viewTransition>
404
- <img
405
- src={src}
406
- alt={alt}
407
- style={{
408
- viewTransitionName: isTransitioning ? "image-expand" : "",
409
- }}
410
- />
411
- </Link>
412
- );
413
- }
414
- ```
415
-
416
- 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:
417
-
418
- ```css
419
- a.transitioning img {
420
- view-transition-name: "image-expand";
421
- }
422
- ```
423
-
424
- ```jsx
425
- <NavLink to={to} unstable_viewTransition>
426
- <img src={src} alt={alt} />
427
- </NavLink>
428
- ```
429
-
430
- 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.
431
-
432
- 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.
433
-
434
- 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)
435
-
436
- ### Patch Changes
437
-
438
- - Log a warning and fail gracefully in `ScrollRestoration` when `sessionStorage` is unavailable ([#10848](https://github.com/remix-run/react-router/pull/10848))
439
- - Updated dependencies:
440
- - `@remix-run/router@1.10.0`
441
- - `react-router@6.17.0`
442
-
443
- ## 6.16.0
444
-
445
- ### Minor Changes
446
-
447
- - Updated dependencies:
448
- - `@remix-run/router@1.9.0`
449
- - `react-router@6.16.0`
450
-
451
- ### Patch Changes
452
-
453
- - Properly encode rendered URIs in server rendering to avoid hydration errors ([#10769](https://github.com/remix-run/react-router/pull/10769))
454
-
455
- ## 6.15.0
456
-
457
- ### Minor Changes
458
-
459
- - 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))
460
-
461
- ### Patch Changes
462
-
463
- - 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))
464
- - 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))
465
- - 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))
466
- - Updated dependencies:
467
- - `@remix-run/router@1.8.0`
468
- - `react-router@6.15.0`
469
-
470
- ## 6.14.2
471
-
472
- ### Patch Changes
473
-
474
- - Properly decode element id when emulating hash scrolling via `<ScrollRestoration>` ([#10682](https://github.com/remix-run/react-router/pull/10682))
475
- - Add missing `<Form state>` prop to populate `history.state` on submission navigations ([#10630](https://github.com/remix-run/react-router/pull/10630))
476
- - Support proper hydration of `Error` subclasses such as `ReferenceError`/`TypeError` ([#10633](https://github.com/remix-run/react-router/pull/10633))
477
- - Updated dependencies:
478
- - `@remix-run/router@1.7.2`
479
- - `react-router@6.14.2`
480
-
481
- ## 6.14.1
482
-
483
- ### Patch Changes
484
-
485
- - Updated dependencies:
486
- - `react-router@6.14.1`
487
- - `@remix-run/router@1.7.1`
488
-
489
- ## 6.14.0
490
-
491
- ### Minor Changes
492
-
493
- - 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))
494
-
495
- ```jsx
496
- // The default behavior will still serialize as FormData
497
- function Component() {
498
- let navigation = useNavigation();
499
- let submit = useSubmit();
500
- submit({ key: "value" }, { method: "post" });
501
- // navigation.formEncType => "application/x-www-form-urlencoded"
502
- // navigation.formData => FormData instance
503
- }
504
-
505
- async function action({ request }) {
506
- // request.headers.get("Content-Type") => "application/x-www-form-urlencoded"
507
- // await request.formData() => FormData instance
508
- }
509
- ```
510
-
511
- ```js
512
- // Opt-into JSON encoding with `encType: "application/json"`
513
- function Component() {
514
- let navigation = useNavigation();
515
- let submit = useSubmit();
516
- submit({ key: "value" }, { method: "post", encType: "application/json" });
517
- // navigation.formEncType => "application/json"
518
- // navigation.json => { key: "value" }
519
- }
520
-
521
- async function action({ request }) {
522
- // request.headers.get("Content-Type") => "application/json"
523
- // await request.json() => { key: "value" }
524
- }
525
- ```
526
-
527
- ```js
528
- // Opt-into text encoding with `encType: "text/plain"`
529
- function Component() {
530
- let navigation = useNavigation();
531
- let submit = useSubmit();
532
- submit("Text submission", { method: "post", encType: "text/plain" });
533
- // navigation.formEncType => "text/plain"
534
- // navigation.text => "Text submission"
535
- }
536
-
537
- async function action({ request }) {
538
- // request.headers.get("Content-Type") => "text/plain"
539
- // await request.text() => "Text submission"
540
- }
541
- ```
542
-
543
- ### Patch Changes
544
-
545
- - 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))
546
- - 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
547
- - If developers want full spec-compliant support for legacy browsers, they can use the `formdata-submitter-polyfill`
548
- - 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))
549
- - ⚠️ 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.)
550
- - Fix `tsc --skipLibCheck:false` issues on React 17 ([#10622](https://github.com/remix-run/react-router/pull/10622))
551
- - Upgrade `typescript` to 5.1 ([#10581](https://github.com/remix-run/react-router/pull/10581))
552
- - Updated dependencies:
553
- - `react-router@6.14.0`
554
- - `@remix-run/router@1.7.0`
555
-
556
- ## 6.13.0
557
-
558
- ### Minor Changes
559
-
560
- - 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))
561
-
562
- Existing behavior will no longer include `React.startTransition`:
563
-
564
- ```jsx
565
- <BrowserRouter>
566
- <Routes>{/*...*/}</Routes>
567
- </BrowserRouter>
568
-
569
- <RouterProvider router={router} />
570
- ```
571
-
572
- If you wish to enable `React.startTransition`, pass the future flag to your component:
573
-
574
- ```jsx
575
- <BrowserRouter future={{ v7_startTransition: true }}>
576
- <Routes>{/*...*/}</Routes>
577
- </BrowserRouter>
578
-
579
- <RouterProvider router={router} future={{ v7_startTransition: true }}/>
580
- ```
581
-
582
- ### Patch Changes
583
-
584
- - Work around webpack/terser `React.startTransition` minification bug in production mode ([#10588](https://github.com/remix-run/react-router/pull/10588))
585
- - Updated dependencies:
586
- - `react-router@6.13.0`
587
-
588
- ## 6.12.1
589
-
590
- > \[!WARNING]
591
- > 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.
592
-
593
- ### Patch Changes
594
-
595
- - Adjust feature detection of `React.startTransition` to fix webpack + react 17 compilation error ([#10569](https://github.com/remix-run/react-router/pull/10569))
596
- - Updated dependencies:
597
- - `react-router@6.12.1`
598
-
599
- ## 6.12.0
600
-
601
- ### Minor Changes
602
-
603
- - Wrap internal router state updates with `React.startTransition` if it exists ([#10438](https://github.com/remix-run/react-router/pull/10438))
604
-
605
- ### Patch Changes
606
-
607
- - 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))
608
- - Updated dependencies:
609
- - `@remix-run/router@1.6.3`
610
- - `react-router@6.12.0`
611
-
612
- ## 6.11.2
613
-
614
- ### Patch Changes
615
-
616
- - Export `SetURLSearchParams` type ([#10444](https://github.com/remix-run/react-router/pull/10444))
617
- - Updated dependencies:
618
- - `react-router@6.11.2`
619
- - `@remix-run/router@1.6.2`
620
-
621
- ## 6.11.1
622
-
623
- ### Patch Changes
624
-
625
- - Updated dependencies:
626
- - `react-router@6.11.1`
627
- - `@remix-run/router@1.6.1`
628
-
629
- ## 6.11.0
630
-
631
- ### Minor Changes
632
-
633
- - Enable `basename` support in `useFetcher` ([#10336](https://github.com/remix-run/react-router/pull/10336))
634
- - 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')`)
635
-
636
- ### Patch Changes
637
-
638
- - Fix inadvertent re-renders when using `Component` instead of `element` on a route definition ([#10287](https://github.com/remix-run/react-router/pull/10287))
639
- - Fail gracefully on `<Link to="//">` and other invalid URL values ([#10367](https://github.com/remix-run/react-router/pull/10367))
640
- - 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))
641
- - Add static prop to `StaticRouterProvider`'s internal `Router` component ([#10401](https://github.com/remix-run/react-router/pull/10401))
642
- - 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))
643
- - Updated dependencies:
644
- - `react-router@6.11.0`
645
- - `@remix-run/router@1.6.0`
646
-
647
- ## 6.10.0
648
-
649
- ### Minor Changes
650
-
651
- - 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))
652
-
653
- - When `future.v7_normalizeFormMethod === false` (default v6 behavior),
654
- - `useNavigation().formMethod` is lowercase
655
- - `useFetcher().formMethod` is lowercase
656
- - When `future.v7_normalizeFormMethod === true`:
657
- - `useNavigation().formMethod` is uppercase
658
- - `useFetcher().formMethod` is uppercase
659
-
660
- ### Patch Changes
661
-
662
- - Fix `createStaticHandler` to also check for `ErrorBoundary` on routes in addition to `errorElement` ([#10190](https://github.com/remix-run/react-router/pull/10190))
663
- - Updated dependencies:
664
- - `@remix-run/router@1.5.0`
665
- - `react-router@6.10.0`
666
-
667
- ## 6.9.0
668
-
669
- ### Minor Changes
670
-
671
- - 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))
672
-
673
- **Example JSON Syntax**
674
-
675
- ```jsx
676
- // Both of these work the same:
677
- const elementRoutes = [{
678
- path: '/',
679
- element: <Home />,
680
- errorElement: <HomeError />,
681
- }]
682
-
683
- const componentRoutes = [{
684
- path: '/',
685
- Component: Home,
686
- ErrorBoundary: HomeError,
687
- }]
688
-
689
- function Home() { ... }
690
- function HomeError() { ... }
691
- ```
692
-
693
- **Example JSX Syntax**
694
-
695
- ```jsx
696
- // Both of these work the same:
697
- const elementRoutes = createRoutesFromElements(
698
- <Route path='/' element={<Home />} errorElement={<HomeError /> } />
699
- );
700
-
701
- const componentRoutes = createRoutesFromElements(
702
- <Route path='/' Component={Home} ErrorBoundary={HomeError} />
703
- );
704
-
705
- function Home() { ... }
706
- function HomeError() { ... }
707
- ```
708
-
709
- - **Introducing Lazy Route Modules!** ([#10045](https://github.com/remix-run/react-router/pull/10045))
710
-
711
- 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`).
712
-
713
- 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.
714
-
715
- Your `lazy` functions will typically return the result of a dynamic import.
716
-
717
- ```jsx
718
- // In this example, we assume most folks land on the homepage so we include that
719
- // in our critical-path bundle, but then we lazily load modules for /a and /b so
720
- // they don't load until the user navigates to those routes
721
- let routes = createRoutesFromElements(
722
- <Route path="/" element={<Layout />}>
723
- <Route index element={<Home />} />
724
- <Route path="a" lazy={() => import("./a")} />
725
- <Route path="b" lazy={() => import("./b")} />
726
- </Route>
727
- );
728
- ```
729
-
730
- Then in your lazy route modules, export the properties you want defined for the route:
731
-
732
- ```jsx
733
- export async function loader({ request }) {
734
- let data = await fetchData(request);
735
- return json(data);
736
- }
737
-
738
- // Export a `Component` directly instead of needing to create a React Element from it
739
- export function Component() {
740
- let data = useLoaderData();
741
-
742
- return (
743
- <>
744
- <h1>You made it!</h1>
745
- <p>{data}</p>
746
- </>
747
- );
748
- }
749
-
750
- // Export an `ErrorBoundary` directly instead of needing to create a React Element from it
751
- export function ErrorBoundary() {
752
- let error = useRouteError();
753
- return isRouteErrorResponse(error) ? (
754
- <h1>
755
- {error.status} {error.statusText}
756
- </h1>
757
- ) : (
758
- <h1>{error.message || error}</h1>
759
- );
760
- }
761
- ```
762
-
763
- 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.
764
-
765
- 🙌 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).
766
-
767
- - Updated dependencies:
768
- - `react-router@6.9.0`
769
- - `@remix-run/router@1.4.0`
770
-
771
- ## 6.8.2
772
-
773
- ### Patch Changes
774
-
775
- - 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))
776
- - Fix `useBlocker` to return `IDLE_BLOCKER` during SSR ([#10046](https://github.com/remix-run/react-router/pull/10046))
777
- - Fix SSR of absolute `<Link to>` urls ([#10112](https://github.com/remix-run/react-router/pull/10112))
778
- - Properly escape HTML characters in `StaticRouterProvider` serialized hydration data ([#10068](https://github.com/remix-run/react-router/pull/10068))
779
- - Updated dependencies:
780
- - `@remix-run/router@1.3.3`
781
- - `react-router@6.8.2`
782
-
783
- ## 6.8.1
784
-
785
- ### Patch Changes
786
-
787
- - Improved absolute url detection in `Link` component (now also supports `mailto:` urls) ([#9994](https://github.com/remix-run/react-router/pull/9994))
788
- - Fix partial object (search or hash only) pathnames losing current path value ([#10029](https://github.com/remix-run/react-router/pull/10029))
789
- - Updated dependencies:
790
- - `react-router@6.8.1`
791
- - `@remix-run/router@1.3.2`
792
-
793
- ## 6.8.0
794
-
795
- ### Minor Changes
796
-
797
- - 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))
798
-
799
- ```tsx
800
- <Link to="https://neworigin.com/some/path"> {/* Document request */}
801
- <Link to="//neworigin.com/some/path"> {/* Document request */}
802
- <Link to="https://www.currentorigin.com/path"> {/* Client-side navigation */}
803
- ```
804
-
805
- ### Patch Changes
806
-
807
- - Fix bug with search params removal via `useSearchParams` ([#9969](https://github.com/remix-run/react-router/pull/9969))
808
- - Respect `preventScrollReset` on `<fetcher.Form>` ([#9963](https://github.com/remix-run/react-router/pull/9963))
809
- - Fix navigation for hash routers on manual URL changes ([#9980](https://github.com/remix-run/react-router/pull/9980))
810
- - 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))
811
- - Updated dependencies:
812
- - `@remix-run/router@1.3.1`
813
- - `react-router@6.8.0`
814
-
815
- ## 6.7.0
816
-
817
- ### Minor Changes
818
-
819
- - Add `unstable_useBlocker` hook for blocking navigations within the app's location origin ([#9709](https://github.com/remix-run/react-router/pull/9709))
820
- - Add `unstable_usePrompt` hook for blocking navigations within the app's location origin ([#9932](https://github.com/remix-run/react-router/pull/9932))
821
- - Add `preventScrollReset` prop to `<Form>` ([#9886](https://github.com/remix-run/react-router/pull/9886))
822
-
823
- ### Patch Changes
824
-
825
- - Added pass-through event listener options argument to `useBeforeUnload` ([#9709](https://github.com/remix-run/react-router/pull/9709))
826
- - Streamline jsdom bug workaround in tests ([#9824](https://github.com/remix-run/react-router/pull/9824))
827
- - Updated dependencies:
828
- - `@remix-run/router@1.3.0`
829
- - `react-router@6.7.0`
830
-
831
- ## 6.6.2
832
-
833
- ### Patch Changes
834
-
835
- - Ensure `useId` consistency during SSR ([#9805](https://github.com/remix-run/react-router/pull/9805))
836
- - Updated dependencies:
837
- - `react-router@6.6.2`
838
-
839
- ## 6.6.1
840
-
841
- ### Patch Changes
842
-
843
- - Updated dependencies:
844
- - `@remix-run/router@1.2.1`
845
- - `react-router@6.6.1`
846
-
847
- ## 6.6.0
848
-
849
- ### Minor Changes
850
-
851
- - Add `useBeforeUnload()` hook ([#9664](https://github.com/remix-run/react-router/pull/9664))
852
- - Remove `unstable_` prefix from `createStaticHandler`/`createStaticRouter`/`StaticRouterProvider` ([#9738](https://github.com/remix-run/react-router/pull/9738))
853
-
854
- ### Patch Changes
855
-
856
- - Proper hydration of `Error` objects from `StaticRouterProvider` ([#9664](https://github.com/remix-run/react-router/pull/9664))
857
- - Support uppercase `<Form method>` and `useSubmit` method values ([#9664](https://github.com/remix-run/react-router/pull/9664))
858
- - Skip initial scroll restoration for SSR apps with `hydrationData` ([#9664](https://github.com/remix-run/react-router/pull/9664))
859
- - Fix `<button formmethod>` form submission overriddes ([#9664](https://github.com/remix-run/react-router/pull/9664))
860
- - Updated dependencies:
861
- - `@remix-run/router@1.2.0`
862
- - `react-router@6.6.0`
863
-
864
- ## 6.5.0
865
-
866
- ### Patch Changes
867
-
868
- - Updated dependencies:
869
- - `react-router@6.5.0`
870
- - `@remix-run/router@1.1.0`
871
-
872
- ## 6.4.5
873
-
874
- ### Patch Changes
875
-
876
- - Updated dependencies:
877
- - `@remix-run/router@1.0.5`
878
- - `react-router@6.4.5`
879
-
880
- ## 6.4.4
881
-
882
- ### Patch Changes
883
-
884
- - 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))
885
- - Properly serialize/deserialize `ErrorResponse` instances when using built-in hydration ([#9593](https://github.com/remix-run/react-router/pull/9593))
886
- - Support `basename` in static data routers ([#9591](https://github.com/remix-run/react-router/pull/9591))
887
- - Updated dependencies:
888
- - `@remix-run/router@1.0.4`
889
- - `react-router@6.4.4`
890
-
891
- ## 6.4.3
892
-
893
- ### Patch Changes
894
-
895
- - Fix hrefs generated for `createHashRouter` ([#9409](https://github.com/remix-run/react-router/pull/9409))
896
- - 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))
897
- - Properly support `index` routes with a `path` in `useResolvedPath` ([#9486](https://github.com/remix-run/react-router/pull/9486))
898
- - Respect `relative=path` prop on `NavLink` ([#9453](https://github.com/remix-run/react-router/pull/9453))
899
- - Fix `NavLink` behavior for root urls ([#9497](https://github.com/remix-run/react-router/pull/9497))
900
- - Updated dependencies:
901
- - `@remix-run/router@1.0.3`
902
- - `react-router@6.4.3`
903
-
904
- ## 6.4.2
905
-
906
- ### Patch Changes
907
-
908
- - Respect `basename` in `useFormAction` ([#9352](https://github.com/remix-run/react-router/pull/9352))
909
- - Enhance console error messages for invalid usage of data router hooks ([#9311](https://github.com/remix-run/react-router/pull/9311))
910
- - 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))
911
- - Updated dependencies:
912
- - `react-router@6.4.2`
913
- - `@remix-run/router@1.0.2`
914
-
915
- ## 6.4.1
916
-
917
- ### Patch Changes
918
-
919
- - Updated dependencies:
920
- - `react-router@6.4.1`
921
- - `@remix-run/router@1.0.1`
922
-
923
- ## 6.4.0
924
-
925
- Whoa 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).
926
-
927
- **New APIs**
928
-
929
- - Create your router with `createMemoryRouter`/`createBrowserRouter`/`createHashRouter`
930
- - Render your router with `<RouterProvider>`
931
- - Load data with a Route `loader` and mutate with a Route `action`
932
- - Handle errors with Route `errorElement`
933
- - Submit data with the new `<Form>` component
934
- - Perform in-page data loads and mutations with `useFetcher()`
935
- - Defer non-critical data with `defer` and `Await`
936
- - Manage scroll position with `<ScrollRestoration>`
937
-
938
- **New Features**
939
-
940
- - Perform path-relative navigations with `<Link relative="path">` (#9160)
941
-
942
- **Bug Fixes**
943
-
944
- - Path resolution is now trailing slash agnostic (#8861)
945
- - `useLocation` returns the scoped location inside a `<Routes location>` component (#9094)
946
- - respect the `<Link replace>` prop if it is defined (#8779)
947
-
948
- **Updated Dependencies**
949
-
950
- - `react-router@6.4.0`