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.0 #600

Merged
merged 1 commit into from
Apr 27, 2024

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Oct 28, 2023

Mend Renovate

This PR contains the following updates:

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

Release Notes

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

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

v6.20.0

Compare Source

Minor Changes
  • Export the PathParam type from the public API (#​10719)
Patch Changes
  • Updated dependencies:
    • react-router@6.20.0
    • @remix-run/router@1.13.0

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:
    • react-router@6.19.0
    • @remix-run/router@1.12.0

v6.18.0

Compare Source

Minor Changes
  • 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) (#​10960)

    • Fetcher keys are now also exposed on the fetchers returned from useFetchers so that they can be looked up by key
  • 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)

    • Invoking a fetcher in this way is ephemeral and stateless
    • If you need to access the state of one of these fetchers, you will need to leverage useFetcher({ key }) to look it up elsewhere
Patch Changes
  • 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)
  • 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)
  • Updated dependencies:
    • @remix-run/router@1.11.0
    • react-router@6.18.0

v6.17.0

Compare Source

Minor Changes
  • Add experimental support for the View Transitions API via document.startViewTransition to enable CSS animated transitions on SPA navigations in your application. (#​10916)

    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.

    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:

    function ImageLink(to, src, alt) {
      let isTransitioning = unstable_useViewTransitionState(to);
      return (
        <Link to={to} unstable_viewTransition>
          <img
            src={src}
            alt={alt}
            style={{
              viewTransitionName: isTransitioning ? "image-expand" : "",
            }}
          />
        </Link>
      );
    }

    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:

    a.transitioning img {
      view-transition-name: "image-expand";
    }
    <NavLink to={to} unstable_viewTransition>
      <img src={src} alt={alt} />
    </NavLink>

    For an example usage of View Transitions with React Router, check out our fork of the Astro Records demo.

    For more information on using the View Transitions API, please refer to the Smooth and simple transitions with the View Transitions API guide from the Google Chrome team.

    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

Patch Changes
  • Log a warning and fail gracefully in ScrollRestoration when sessionStorage is unavailable (#​10848)
  • Updated dependencies:
    • @remix-run/router@1.10.0
    • react-router@6.17.0

Configuration

📅 Schedule: Branch creation - "every weekend" (UTC), 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 3 times, most recently from b4e3a61 to 1fe6308 Compare October 29, 2023 02:54
@renovate renovate bot changed the title Update dependency react-router-dom to v6.17.0 Update dependency react-router-dom to v6.18.0 Oct 31, 2023
@renovate renovate bot force-pushed the renovate/react-router-monorepo branch 2 times, most recently from 440dcac to 71cf011 Compare November 5, 2023 09:47
@renovate renovate bot changed the title Update dependency react-router-dom to v6.18.0 Update dependency react-router-dom to v6.19.0 Nov 16, 2023
@renovate renovate bot force-pushed the renovate/react-router-monorepo branch from 71cf011 to fdadcc0 Compare November 16, 2023 15:53
@renovate renovate bot changed the title Update dependency react-router-dom to v6.19.0 Update dependency react-router-dom to v6.20.0 Nov 22, 2023
@renovate renovate bot force-pushed the renovate/react-router-monorepo branch from fdadcc0 to fd53c99 Compare November 22, 2023 20:11
@renovate renovate bot changed the title Update dependency react-router-dom to v6.20.0 Update dependency react-router-dom to v6.20.1 Dec 1, 2023
@renovate renovate bot force-pushed the renovate/react-router-monorepo branch 2 times, most recently from 9a4a66f to 61669f7 Compare December 2, 2023 07:33
@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 14, 2023
@renovate renovate bot force-pushed the renovate/react-router-monorepo branch from 61669f7 to a8dbb52 Compare December 14, 2023 02: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 21, 2023
@renovate renovate bot force-pushed the renovate/react-router-monorepo branch from a8dbb52 to 948fbb2 Compare December 21, 2023 17:08
@renovate renovate bot force-pushed the renovate/react-router-monorepo branch from 948fbb2 to b392b9b Compare January 10, 2024 09:48
@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 11, 2024
@renovate renovate bot force-pushed the renovate/react-router-monorepo branch from b392b9b to 235402b Compare January 11, 2024 17:53
@renovate renovate bot force-pushed the renovate/react-router-monorepo branch from 235402b to 5bc94e1 Compare January 18, 2024 22:59
@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 18, 2024
@renovate renovate bot force-pushed the renovate/react-router-monorepo branch from 5bc94e1 to b2f02dd Compare February 1, 2024 22:47
@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 1, 2024
@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 16, 2024
@renovate renovate bot force-pushed the renovate/react-router-monorepo branch from b2f02dd to 8ad4cd9 Compare February 16, 2024 22:53
@renovate renovate bot changed the title Update dependency react-router-dom to v6.22.1 Update dependency react-router-dom to v6.22.2 Feb 28, 2024
@renovate renovate bot force-pushed the renovate/react-router-monorepo branch from 8ad4cd9 to c6a5d78 Compare February 28, 2024 21:20
@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 7, 2024
@renovate renovate bot force-pushed the renovate/react-router-monorepo branch from c6a5d78 to 195b604 Compare March 7, 2024 15:37
@renovate renovate bot force-pushed the renovate/react-router-monorepo branch from 195b604 to fbde701 Compare April 23, 2024 16:40
@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 23, 2024
@renovate renovate bot force-pushed the renovate/react-router-monorepo branch from fbde701 to 99641d1 Compare April 27, 2024 09:40
@ranger-ross ranger-ross merged commit 8041109 into main Apr 27, 2024
3 checks passed
@ranger-ross ranger-ross deleted the renovate/react-router-monorepo branch April 27, 2024 09:43
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.

1 participant