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