Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update dependency react-router-dom to v6.23.1 #281

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Dec 4, 2023

Mend Renovate

This PR contains the following updates:

Package Change Age Adoption Passing Confidence
react-router-dom (source) 6.20.0 -> 6.23.1 age adoption passing confidence

Release Notes

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

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/router@1.16.1
    • react-router@6.23.1

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/router@1.16.0
    • react-router@6.23.0

v6.22.3

Compare Source

Patch Changes
  • Updated dependencies:
    • @remix-run/router@1.15.3
    • react-router@6.22.3

v6.22.2

Compare Source

Patch Changes
  • Updated dependencies:
    • @remix-run/router@1.15.2
    • react-router@6.22.2

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/router@1.15.0
    • react-router@6.22.0

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:
    • react-router@6.21.3

v6.21.2

Compare Source

v6.21.1

Compare Source

Patch Changes
  • Updated dependencies:
    • react-router@6.21.1
    • @remix-run/router@1.14.1

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/router@1.14.0
    • react-router@6.21.0

v6.20.1

Compare Source

Patch Changes

Configuration

📅 Schedule: Branch creation - "every weekday,every weekend" in timezone Asia/Tokyo, 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 has been generated by Mend Renovate. View repository job log here.

@renovate renovate bot force-pushed the renovate/react-router-monorepo branch from 17b4fb0 to 145ca6d Compare December 16, 2023 22:19
@renovate renovate bot changed the title Update dependency react-router-dom to v6.20.1 Update dependency react-router-dom to v6.21.0 Dec 16, 2023
@renovate renovate bot force-pushed the renovate/react-router-monorepo branch from 145ca6d to e6b6b7d Compare December 24, 2023 18:48
@renovate renovate bot changed the title Update dependency react-router-dom to v6.21.0 Update dependency react-router-dom to v6.21.1 Dec 24, 2023
@renovate renovate bot force-pushed the renovate/react-router-monorepo branch from e6b6b7d to 814adad Compare January 14, 2024 16:51
@renovate renovate bot changed the title Update dependency react-router-dom to v6.21.1 Update dependency react-router-dom to v6.21.2 Jan 14, 2024
@renovate renovate bot changed the title Update dependency react-router-dom to v6.21.2 Update dependency react-router-dom to v6.21.3 Jan 21, 2024
@renovate renovate bot force-pushed the renovate/react-router-monorepo branch from 814adad to 73d9597 Compare January 21, 2024 21:30
@renovate renovate bot force-pushed the renovate/react-router-monorepo branch from 73d9597 to 7ce346c Compare February 4, 2024 21:23
@renovate renovate bot changed the title Update dependency react-router-dom to v6.21.3 Update dependency react-router-dom to v6.22.0 Feb 4, 2024
@renovate renovate bot force-pushed the renovate/react-router-monorepo branch from 7ce346c to 779f531 Compare February 19, 2024 22:26
@renovate renovate bot changed the title Update dependency react-router-dom to v6.22.0 Update dependency react-router-dom to v6.22.1 Feb 19, 2024
@renovate renovate bot force-pushed the renovate/react-router-monorepo branch from 779f531 to 9790b50 Compare March 2, 2024 21:22
@renovate renovate bot changed the title Update dependency react-router-dom to v6.22.1 Update dependency react-router-dom to v6.22.2 Mar 2, 2024
@renovate renovate bot force-pushed the renovate/react-router-monorepo branch from 9790b50 to c65769f Compare March 10, 2024 17:12
@renovate renovate bot changed the title Update dependency react-router-dom to v6.22.2 Update dependency react-router-dom to v6.22.3 Mar 10, 2024
@renovate renovate bot force-pushed the renovate/react-router-monorepo branch from c65769f to 86bce12 Compare April 26, 2024 16:48
@renovate renovate bot changed the title Update dependency react-router-dom to v6.22.3 Update dependency react-router-dom to v6.23.0 Apr 26, 2024
@renovate renovate bot force-pushed the renovate/react-router-monorepo branch from 86bce12 to daa52d8 Compare May 13, 2024 19:06
@renovate renovate bot changed the title Update dependency react-router-dom to v6.23.0 Update dependency react-router-dom to v6.23.1 May 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

0 participants