Update dependency react-router-dom to v7 #7

renovate · 2024-11-22T08:55:56Z

This PR contains the following updates:

Package	Change	Age	Adoption	Passing	Confidence
react-router-dom (source)	`^6.18.0` -> `^7.0.0`

Release Notes

remix-run/react-router (react-router-dom)

`v7.0.1`

Compare Source

Patch Changes

Updated dependencies:
- [email protected]

`v7.0.0`

Compare Source

Major Changes

Remove the original defer implementation in favor of using raw promises via single fetch and turbo-stream. This removes these exports from React Router: (#11744)
- defer
- AbortedDeferredError
- type TypedDeferredData
- UNSAFE_DeferredData
- UNSAFE_DEFERRED_SYMBOL,
Use createRemixRouter/RouterProvider in entry.client instead of RemixBrowser (#11469)
Remove single_fetch future flag. (#11522)
Remove future.v7_startTransition flag (#11696)
Remove future.v7_normalizeFormMethod future flag (#11697)
Allow returning undefined from actions and loaders (#11680)
update minimum node version to 18 (#11690)
Remove future.v7_prependBasename from the ionternalized @remix-run/router package (#11726)
Remove future.v7_throwAbortReason from internalized @remix-run/router package (#11728)
Add exports field to all packages (#11675)
node package no longer re-exports from react-router (#11702)
updates the minimum React version to 18 (#11689)
- Remove the future.v7_partialHydration flag (#11725)
  - This also removes the <RouterProvider fallbackElement> prop
    - To migrate, move the fallbackElement to a hydrateFallbackElement/HydrateFallback on your root route
  - Also worth nothing there is a related breaking changer with this future flag:
    - Without future.v7_partialHydration (when using fallbackElement), state.navigation was populated during the initial load
    - With future.v7_partialHydration, state.navigation remains in an "idle" state during the initial load
Remove future.v7_fetcherPersist flag (#11731)

Minor Changes

Add prefetching support to Link/NavLink when using Remix SSR (#11402)
Enhance ScrollRestoration so it can restore properly on an SSR'd document load (#11401)
Add built-in Remix-style hydration support to RouterProvider. When running from a Remix-SSR'd HTML payload with the proper window variables (__remixContext, __remixManifest, __remixRouteModules), you don't need to pass a router prop and RouterProvider will create the router for you internally. (#11396) (#11400)

Patch Changes

Memoize some RouterProvider internals to reduce uneccesary re-renders (#11817)
Updated dependencies:
- [email protected]

`v6.28.0`

Compare Source

Minor Changes

- Log deprecation warnings for v7 flags (#11750)
- Add deprecation warnings to json/defer in favor of returning raw objects
  - These methods will be removed in React Router v7

Patch Changes

Update JSDoc URLs for new website structure (add /v6/ segment) (#12141)
Updated dependencies:
- [email protected]
- @remix-run/[email protected]

Minor Changes

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)

Patch Changes

Fix initial hydration behavior when using future.v7_partialHydration along with unstable_patchRoutesOnMiss (#11838)
- During initial hydration, router.state.matches will now include any partial matches so that we can render ancestor HydrateFallback components
Updated dependencies:
- @remix-run/[email protected]
- [email protected]

`v6.25.1`

Compare Source

Patch Changes

Memoize some RouterProvider internals to reduce unnecessary re-renders (#11803)
Updated dependencies:
- [email protected]

`v6.25.0`

Compare Source

Minor Changes

Stabilize future.unstable_skipActionErrorRevalidation as future.v7_skipActionErrorRevalidation (#11769)
- When this flag is enabled, actions will not automatically trigger a revalidation if they return/throw a Response with a 4xx/5xx status code
- You may still opt-into revalidation via shouldRevalidate
- This also changes shouldRevalidate's unstable_actionStatus parameter to actionStatus

Patch Changes

Updated dependencies:
- [email protected]
- @remix-run/[email protected]

`v6.24.1`

Compare Source

Patch Changes

Remove polyfill.io reference from warning message because the domain was sold and has since been determined to serve malware (#11741)
- See https://sansec.io/research/polyfill-supply-chain-attack
Export NavLinkRenderProps type for easier typing of custom NavLink callback (#11553)
Updated dependencies:
- @remix-run/[email protected]
- [email protected]

`v6.24.0`

Compare Source

Minor Changes

Add support for Lazy Route Discovery (a.k.a. Fog of War) (#11626)
- RFC: https://redirect.github.com/remix-run/react-router/discussions/11113
- unstable_patchRoutesOnMiss docs: https://reactrouter.com/en/main/routers/create-browser-router

Patch Changes

Fix fetcher.submit types - remove incorrect navigate/fetcherKey/unstable_viewTransition options because they are only relevant for useSubmit (#11631)
Allow falsy location.state values passed to <StaticRouter> (#11495)
Updated dependencies:
- [email protected]
- @remix-run/[email protected]

`v6.23.1`

Compare Source

Patch Changes

Check for document existence when checking startViewTransition (#11544)
Change the react-router-dom/server import back to react-router-dom instead of index.ts (#11514)
Updated dependencies:
- @remix-run/[email protected]
- [email protected]

`v6.23.0`

Compare Source

Minor Changes

Add a new unstable_dataStrategy configuration option (#11098)
- This option allows Data Router applications to take control over the approach for executing route loaders and actions
- 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

Patch Changes

Updated dependencies:
- @remix-run/[email protected]
- [email protected]

`v6.22.3`

Compare Source

Patch Changes

Updated dependencies:
- @remix-run/[email protected]
- [email protected]

`v6.22.2`

Compare Source

Patch Changes

Updated dependencies:
- @remix-run/[email protected]
- [email protected]

`v6.22.1`

Compare Source

`v6.22.0`

Compare Source

Minor Changes

Include a window__reactRouterVersion tag for CWV Report detection (#11222)

Patch Changes

Updated dependencies:
- @remix-run/[email protected]
- [email protected]

`v6.21.3`

Compare Source

Patch Changes

Fix NavLink isPending when a basename is used (#11195)
Remove leftover unstable_ prefix from Blocker/BlockerFunction types (#11187)
Updated dependencies:
- [email protected]

`v6.21.2`

Compare Source

`v6.21.1`

Compare Source

Patch Changes

Updated dependencies:
- [email protected]
- @remix-run/[email protected]

`v6.21.0`

Compare Source

Minor Changes

Add a new future.v7_relativeSplatPath flag to implement a breaking bug fix to relative routing when inside a splat route. (#11087)

This fix was originally added in #10983 and was later reverted in #11078 because it was determined that a large number of existing applications were relying on the buggy behavior (see #11052)

The Bug
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.

The Background
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:

<BrowserRouter>
  <Routes>
    <Route path="/" element={<Home />} />
    <Route path="dashboard/*" element={<Dashboard />} />
  </Routes>
</BrowserRouter>

Any paths like /dashboard, /dashboard/team, /dashboard/projects will match the Dashboard route. The dashboard component itself can then render nested <Routes>:

function Dashboard() {
  return (
    <div>
      <h2>Dashboard</h2>
      <nav>
        <Link to="/">Dashboard Home</Link>
        <Link to="team">Team</Link>
        <Link to="projects">Projects</Link>
      </nav>

      <Routes>
        <Route path="/" element={<DashboardHome />} />
        <Route path="team" element={<DashboardTeam />} />
        <Route path="projects" element={<DashboardProjects />} />
      </Routes>
    </div>
  );
}

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.

The Problem

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 ".":

// If we are on URL /dashboard/team, and we want to link to /dashboard/team:
function DashboardTeam() {
  // ❌ This is broken and results in <a href="/dashboard">
  return <Link to=".">A broken link to the Current URL</Link>;

  // ✅ This is fixed but super unintuitive since we're already at /dashboard/team!
  return <Link to="./team">A broken link to the Current URL</Link>;
}

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.

Even worse, consider a nested splat route configuration:

<BrowserRouter>
  <Routes>
    <Route path="dashboard">
      <Route path="*" element={<Dashboard />} />
    </Route>
  </Routes>
</BrowserRouter>

Now, a <Link to="."> and a <Link to=".."> inside the Dashboard component go to the same place! That is definitely not correct!

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:

let router = createBrowserRouter({
  path: "/dashboard",
  children: [
    {
      path: "*",
      action: dashboardAction,
      Component() {
        // ❌ This form is broken!  It throws a 405 error when it submits because
        // it tries to submit to /dashboard (without the splat value) and the parent
        // `/dashboard` route doesn't have an action
        return <Form method="post">...</Form>;
      },
    },
  ],
});

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.

The Solution
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:

<BrowserRouter>
  <Routes>
    <Route path="dashboard">
      <Route index path="*" element={<Dashboard />} />
    </Route>
  </Routes>
</BrowserRouter>

function Dashboard() {
  return (
    <div>
      <h2>Dashboard</h2>
      <nav>
        <Link to="..">Dashboard Home</Link>
        <Link to="../team">Team</Link>
        <Link to="../projects">Projects</Link>
      </nav>

      <Routes>
        <Route path="/" element={<DashboardHome />} />
        <Route path="team" element={<DashboardTeam />} />
        <Route path="projects" element={<DashboardProjects />} />
      </Router>
    </div>
  );
}

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".

Patch Changes

Updated dependencies:
- @remix-run/[email protected]
- [email protected]

`v6.20.1`

Compare Source

Patch Changes

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)
Updated dependencies:
- [email protected]
- @remix-run/[email protected]

`v6.20.0`

Compare Source

Minor Changes

Export the PathParam type from the public API (#10719)

Patch Changes

Updated dependencies:
- [email protected]
- @remix-run/[email protected]

`v6.19.0`

Compare Source

Minor Changes

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)
Allow unstable_usePrompt to accept a BlockerFunction in addition to a boolean (#10991)

Patch Changes

Fix issue where a changing fetcher key in a useFetcher that remains mounted wasn't getting picked up (#11009)
Fix useFormAction which was incorrectly inheriting the ?index query param from child route action submissions (#11025)
Fix NavLink active logic when to location has a trailing slash (#10734)
Updated dependencies:
- [email protected]
- @remix-run/[email protected]

Configuration

📅 Schedule: Branch creation - "after 7am every weekday,before 5pm every weekday" in timezone America/New_York, Automerge - At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.

If you want to rebase/retry this PR, check this box

This PR was generated by Mend Renovate. View the repository job log.

Update dependency react-router-dom to v7

8362dce

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update dependency react-router-dom to v7 #7

Update dependency react-router-dom to v7 #7

renovate bot commented Nov 22, 2024 •

edited

Loading

Update dependency react-router-dom to v7 #7

Are you sure you want to change the base?

Update dependency react-router-dom to v7 #7

Conversation

renovate bot commented Nov 22, 2024 • edited Loading

Release Notes

Patch Changes

Major Changes

Minor Changes

Patch Changes

Minor Changes

Patch Changes

Minor Changes

Patch Changes

Patch Changes

Minor Changes

Patch Changes

Patch Changes

Minor Changes

Patch Changes

Patch Changes

Minor Changes

Patch Changes

Patch Changes

Patch Changes

Minor Changes

Patch Changes

Patch Changes

Patch Changes

Minor Changes

Patch Changes

Patch Changes

Minor Changes

Patch Changes

Minor Changes

Patch Changes

Configuration

renovate bot commented Nov 22, 2024 •

edited

Loading