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