fix(deps): update react-router monorepo to v6.29.0 #28

renovate · 2023-02-18T17:45:50Z

This PR contains the following updates:

Package	Change	Age	Adoption	Passing	Confidence
react-router (source)	`6.6.2` -> `6.29.0`
react-router-dom (source)	`6.6.2` -> `6.29.0`

Release Notes

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

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:
- @remix-run/router@1.21.0

`v6.27.0`: v6.27.0

Compare Source

See the changelog for release notes: https://github.com/remix-run/react-router/blob/main/CHANGELOG.md#v6270

`v6.26.2`

Compare Source

Patch Changes

Updated dependencies:
- @remix-run/router@1.19.2

`v6.26.1`

Compare Source

`v6.26.0`

Compare Source

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/router@1.19.0

`v6.25.1`: v6.25.1

Compare Source

See the changelog for release notes: https://github.com/remix-run/react-router/blob/main/CHANGELOG.md#v6251

`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

Fix regression and properly decode paths inside useMatch so matches/params reflect decoded params (#11789)
Updated dependencies:
- @remix-run/router@1.18.0

`v6.24.1`

Compare Source

Patch Changes

When using future.v7_relativeSplatPath, properly resolve relative paths in splat routes that are children of pathless routes (#11633)
Updated dependencies:
- @remix-run/router@1.17.1

`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

Updated dependencies:
- @remix-run/router@1.17.0

`v6.23.1`

Compare Source

Patch Changes

allow undefined to be resolved with <Await> (#11513)
Updated dependencies:
- @remix-run/router@1.16.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

`v6.22.3`

Compare Source

Patch Changes

Updated dependencies:
- @remix-run/router@1.15.3

`v6.22.2`

Compare Source

Patch Changes

Updated dependencies:
- @remix-run/router@1.15.2

`v6.22.1`: v6.22.1

Compare Source

See the changelog for release notes: https://github.com/remix-run/react-router/blob/main/CHANGELOG.md#v6221

`v6.22.0`

Compare Source

Patch Changes

Updated dependencies:
- @remix-run/router@1.15.0

`v6.21.3`

Compare Source

Patch Changes

Remove leftover unstable_ prefix from Blocker/BlockerFunction types (#11187)

`v6.21.2`

Compare Source

`v6.21.1`

Compare Source

Patch Changes

Fix bug with route.lazy not working correctly on initial SPA load when v7_partialHydration is specified (#11121)
Updated dependencies:
- @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

Properly handle falsy error values in ErrorBoundary's (#11071)
Updated dependencies:
- @remix-run/router@1.14.0

`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:
- @remix-run/router@1.13.1

`v6.20.0`

Compare Source

Minor Changes

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

Patch Changes

Fix bug with resolveTo in splat routes (#11045)
- This is a follow up to #10983 to handle the few other code paths using getPathContributingMatches
- This removes the UNSAFE_getPathContributingMatches export from @remix-run/router since we no longer need this in the react-router/react-router-dom layers
Updated dependencies:
- @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)
Remove the unstable_ prefix from the useBlocker hook as it's been in use for enough time that we are confident in the API. We do not plan to remove the prefix from unstable_usePrompt due to differences in how browsers handle window.confirm that prevent React Router from guaranteeing consistent/correct behavior. (#10991)

Patch Changes

Fix useActionData so it returns proper contextual action data and not any action data in the tree (#11023)
Fix bug in useResolvedPath that would cause useResolvedPath(".") in a splat route to lose the splat portion of the URL path. (#10983)
- ⚠️ This fixes a quite long-standing bug specifically for "." paths inside a splat route which incorrectly dropped the splat portion of the URL. If you are relative routing via "." inside a splat route in your application you should double check that your logic is not relying on this buggy behavior and update accordingly.
Updated dependencies:
- @remix-run/router@1.12.0

`v6.18.0`

Compare Source

Patch Changes

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

`v6.17.0`

Compare Source

Patch Changes

Fix RouterProvider future prop type to be a Partial<FutureConfig> so that not all flags must be specified (#10900)
Updated dependencies:
- @remix-run/router@1.10.0

`v6.16.0`

Compare Source

Minor Changes

In order to move towards stricter TypeScript support in the future, we're aiming to replace current usages of any with unknown on exposed typings for user-provided data. To do this in Remix v2 without introducing breaking changes in React Router v6, we have added generics to a number of shared types. These continue to default to any in React Router and are overridden with unknown in Remix. In React Router v7 we plan to move these to unknown as a breaking change. (#10843)
- Location now accepts a generic for the location.state value
- ActionFunctionArgs/ActionFunction/LoaderFunctionArgs/LoaderFunction now accept a generic for the context parameter (only used in SSR usages via createStaticHandler)
- The return type of useMatches (now exported as UIMatch) accepts generics for match.data and match.handle - both of which were already set to unknown
Move the @private class export ErrorResponse to an UNSAFE_ErrorResponseImpl export since it is an implementation detail and there should be no construction of ErrorResponse instances in userland. This frees us up to export a type ErrorResponse which correlates to an instance of the class via InstanceType. Userland code should only ever be using ErrorResponse as a type and should be type-narrowing via isRouteErrorResponse. (#10811)
Export ShouldRevalidateFunctionArgs interface (#10797)
Removed private/internal APIs only required for the Remix v1 backwards compatibility layer and no longer needed in Remix v2 (_isFetchActionRedirect, _hasFetcherDoneAnything) (#10715)

Patch Changes

Updated dependencies:
- @remix-run/router@1.9.0

`v6.15.0`

Compare Source

Minor Changes

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)

Patch Changes

Ensure useRevalidator is referentially stable across re-renders if revalidations are not actively occurring (#10707)
Updated dependencies:
- @remix-run/router@1.8.0

`v6.14.2`

Compare Source

Patch Changes

Updated dependencies:
- @remix-run/router@1.7.2

`v6.14.1`

Compare Source

Patch Changes

Fix loop in unstable_useBlocker when used with an unstable blocker function (#10652)
Fix issues with reused blockers on subsequent navigations (#10656)
Updated dependencies:
- @remix-run/router@1.7.1

`v6.14.0`

Compare Source

Patch Changes

Strip basename from locations provided to unstable_useBlocker functions to match useLocation (#10573)
Fix generatePath when passed a numeric 0 value parameter (#10612)
Fix unstable_useBlocker key issues in StrictMode (#10573)
Fix tsc --skipLibCheck:false issues on React 17 (#10622)
Upgrade typescript to 5.1 (#10581)
Updated dependencies:
- @remix-run/router@1.7.0

`v6.13.0`

Compare Source

Minor Changes

Move React.startTransition usage behind a future flag 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)

Existing behavior will no longer include React.startTransition:
```
<BrowserRouter>
  <Routes>{/*...*/}</Routes>
</BrowserRouter>

<RouterProvider router={router} />
```
If you wish to enable React.startTransition, pass the future flag to your component:
```
<BrowserRouter future={{ v7_startTransition: true }}>
  <Routes>{/*...*/}</Routes>
</BrowserRouter>

<RouterProvider router={router} future={{ v7_startTransition: true }}/>
```

Patch Changes

Work around webpack/terser React.startTransition minification bug in production mode (#10588)

`v6.12.1`

Compare Source

Warning
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 for more details.

Patch Changes

Adjust feature detection of React.startTransition to fix webpack + react 17 compilation error (#10569)

`v6.12.0`

Compare Source

Minor Changes

Wrap internal router state updates with React.startTransition if it exists (#10438)

Patch Changes

Updated dependencies:
- @remix-run/router@1.6.3

`v6.11.2`

Compare Source

Patch Changes

Fix basename duplication in descendant <Routes> inside a <RouterProvider> (#10492)
Updated dependencies:
- @remix-run/router@1.6.2

`v6.11.1`

Compare Source

Patch Changes

Fix usage of Component API within descendant <Routes> (#10434)
Fix bug when calling useNavigate from <Routes> inside a <RouterProvider> (#10432)
Fix usage of <Navigate> in strict mode when using a data router (#10435)
Updated dependencies:
- @remix-run/router@1.6.1

`v6.11.0`

Compare Source

Patch Changes

Log loader/action errors to the console in dev for easier stack trace evaluation (#10286)
Fix bug preventing rendering of descendant <Routes> when RouterProvider errors existed (#10374)
Fix inadvertent re-renders when using Component instead of element on a route definition (#10287)
Fix detection of useNavigate in the render cycle by setting the activeRef in a layout effect, allowing the navigate function to be passed to child components and called in a useEffect there. (#10394)
Switched from useSyncExternalStore to useState for internal @remix-run/router router state syncing in <RouterProvider>. We found some subtle bugs where router state updates got propagated before other normal useState updates, which could lead to footguns in useEffect calls. (#10377, #10409)
Allow useRevalidator() to resolve a loader-driven error boundary scenario (#10369)
Avoid unnecessary unsubscribe/resubscribes on router state changes (#10409)
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)
Updated dependencies:
- @remix-run/router@1.6.0

`v6.10.0`

Compare Source

Minor Changes

Added support for Future Flags 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)
- When future.v7_normalizeFormMethod === false (default v6 behavior),
  - useNavigation().formMethod is lowercase
  - useFetcher().formMethod is lowercase
- When future.v7_normalizeFormMethod === true:
  - useNavigation().formMethod is uppercase
  - useFetcher().formMethod is uppercase

Patch Changes

Fix route ID generation when using Fragments in createRoutesFromElements (#10193)
Updated dependencies:
- @remix-run/router@1.5.0

`v6.9.0`

Compare Source

Minor Changes

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)

Example JSON Syntax

// Both of these work the same:
const elementRoutes = [{
  path: '/',
  element: <Home />,
  errorElement: <HomeError />,
}]

const componentRoutes = [{
  path: '/',
  Component: Home,
  ErrorBoundary: HomeError,
}]

function Home() { ... }
function HomeError() { ... }

Example JSX Syntax

// Both of these work the same:
const elementRoutes = createRoutesFromElements(
  <Route path='/' element={<Home />} errorElement={<HomeError /> } />
);

const componentRoutes = createRoutesFromElements(
  <Route path='/' Component={Home} ErrorBoundary={HomeError} />
);

function Home() { ... }
function HomeError() { ... }

Introducing Lazy Route Modules! (#10045)

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

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.

Your lazy functions will typically return the result of a dynamic import.

// In this example, we assume most folks land on the homepage so we include that
// in our critical-path bundle, but then we lazily load modules for /a and /b so
// they don't load until the user navigates to those routes
let routes = createRoutesFromElements(
  <Route path="/" element={<Layout />}>
    <Route index element={<Home />} />
    <Route path="a" lazy={() => import("./a")} />
    <Route path="b" lazy={() => import("./b")} />
  </Route>
);

Then in your lazy route modules, export the properties you want defined for the route:

export async function loader({ request }) {
  let data = await fetchData(request);
  return json(data);
}

// Export a `Component` directly instead of needing to create a React Element from it
export function Component() {
  let data = useLoaderData();

  return (
    <>
      <h1>You made it!</h1>
      <p>{data}</p>
    </>
  );
}

// Export an `ErrorBoundary` directly instead of needing to create a React Element from it
export function ErrorBoundary() {
  let error = useRouteError();
  return isRouteErrorResponse(error) ? (
    <h1>
      {error.status} {error.statusText}
    </h1>
  ) : (
    <h1>{error.message || error}</h1>
  );
}

An example of this in action can be found in the examples/lazy-loading-router-provider directory of the repository.

🙌 Huge thanks to @rossipedia for the Initial Proposal and POC Implementation.

Updated dependencies:
- @remix-run/router@1.4.0

Patch Changes

Fix generatePath incorrectly applying parameters in some cases (#10078)
Improve memoization for context providers to avoid unnecessary re-renders (#9983)

`v6.8.2`

Compare Source

Patch Changes

Updated dependencies:
- @remix-run/router@1.3.3

`v6.8.1`

Compare Source

Patch Changes

Remove inaccurate console warning for POP navigations and update active blocker logic (#10030)
Updated dependencies:
- @remix-run/router@1.3.2

`v6.8.0`

Compare Source

Patch Changes

Updated dependencies:
- @remix-run/router@1.3.1

`v6.7.0`

Compare Source

Minor Changes

Add unstable_useBlocker hook for blocking navigations within the app's location origin (#9709)

Patch Changes

Fix generatePath when optional params are present (#9764)
Update <Await> to accept ReactNode as children function return result (#9896)
Updated dependencies:
- @remix-run/router@1.3.0

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

`v6.29.0`

Compare Source

`v6.28.2`

Compare Source

`v6.28.1`

Compare Source

`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:
- react-router@6.28.0
- @remix-run/router@1.21.0

`v6.27.0`

Compare Source

`v6.26.2`

Compare Source

`v6.26.1`

Compare Source

`v6.26.0`

Compare Source

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/router@1.19.0
- react-router@6.26.0

`v6.25.1`

Compare Source

Patch Changes

Memoize some RouterProvider internals to reduce unnecessary re-renders (#11803)
Updated dependencies:
- react-router@6.25.1

`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:
- react-router@6.25.0
- @remix-run/router@1.18.0

`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/router@1.17.1
- react-router@6.24.1

`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:
- react-router@6.24.0
- @remix-run/router@1.17.0

`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={<

Configuration

📅 Schedule: Branch creation - At any time (no schedule defined), 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 these updates again.

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

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

renovate bot changed the title ~~fix(deps): update react-router monorepo to v6.8.1~~ fix(deps): update react-router monorepo to v6.8.2 Feb 27, 2023

renovate bot force-pushed the renovate/react-router-monorepo branch from e51e7c0 to 5ff0a54 Compare February 27, 2023 23:46

renovate bot force-pushed the renovate/react-router-monorepo branch from 5ff0a54 to d9a99f4 Compare March 10, 2023 15:29

renovate bot changed the title ~~fix(deps): update react-router monorepo to v6.8.2~~ fix(deps): update react-router monorepo to v6.9.0 Mar 10, 2023

renovate bot changed the title ~~fix(deps): update react-router monorepo to v6.9.0~~ fix(deps): update react-router monorepo to v6.10.0 Mar 29, 2023

renovate bot force-pushed the renovate/react-router-monorepo branch from d9a99f4 to 203b764 Compare March 29, 2023 23:35

renovate bot changed the title ~~fix(deps): update react-router monorepo to v6.10.0~~ fix(deps): update react-router monorepo to v6.11.2 May 28, 2023

renovate bot force-pushed the renovate/react-router-monorepo branch from 203b764 to 4c20b4d Compare May 28, 2023 12:23

renovate bot force-pushed the renovate/react-router-monorepo branch from 4c20b4d to 16940f9 Compare June 6, 2023 23:11

renovate bot changed the title ~~fix(deps): update react-router monorepo to v6.11.2~~ fix(deps): update react-router monorepo to v6.12.0 Jun 6, 2023

renovate bot force-pushed the renovate/react-router-monorepo branch from 16940f9 to e15f592 Compare June 8, 2023 16:55

renovate bot changed the title ~~fix(deps): update react-router monorepo to v6.12.0~~ fix(deps): update react-router monorepo Jun 8, 2023

renovate bot changed the title ~~fix(deps): update react-router monorepo~~ fix(deps): update react-router monorepo to v6.12.1 Jun 8, 2023

renovate bot force-pushed the renovate/react-router-monorepo branch from e15f592 to 073f9d6 Compare June 8, 2023 18:19

renovate bot changed the title ~~fix(deps): update react-router monorepo to v6.12.1~~ fix(deps): update react-router monorepo to v6.13.0 Jun 14, 2023

renovate bot force-pushed the renovate/react-router-monorepo branch from 073f9d6 to 281287b Compare June 14, 2023 16:42

renovate bot changed the title ~~fix(deps): update react-router monorepo to v6.13.0~~ fix(deps): update react-router monorepo to v6.14.0 Jun 23, 2023

renovate bot force-pushed the renovate/react-router-monorepo branch from 281287b to 760cfb9 Compare June 23, 2023 22:34

renovate bot changed the title ~~fix(deps): update react-router monorepo to v6.14.0~~ fix(deps): update react-router monorepo to v6.14.1 Jun 30, 2023

renovate bot force-pushed the renovate/react-router-monorepo branch from 760cfb9 to a2ad660 Compare June 30, 2023 22:34

renovate bot changed the title ~~fix(deps): update react-router monorepo to v6.14.1~~ fix(deps): update react-router monorepo to v6.14.2 Jul 17, 2023

renovate bot force-pushed the renovate/react-router-monorepo branch from a2ad660 to 4f8b583 Compare July 17, 2023 21:26

renovate bot changed the title ~~fix(deps): update react-router monorepo to v6.14.2~~ fix(deps): update react-router monorepo to v6.15.0 Aug 10, 2023

renovate bot force-pushed the renovate/react-router-monorepo branch from 4f8b583 to 6699f21 Compare August 10, 2023 15:48

renovate bot changed the title ~~fix(deps): update react-router monorepo to v6.15.0~~ fix(deps): update react-router monorepo to v6.16.0 Sep 13, 2023

renovate bot force-pushed the renovate/react-router-monorepo branch from 6699f21 to c9ac859 Compare September 13, 2023 16:51

renovate bot changed the title ~~fix(deps): update react-router monorepo to v6.16.0~~ fix(deps): update react-router monorepo to v6.17.0 Oct 16, 2023

renovate bot force-pushed the renovate/react-router-monorepo branch from c9ac859 to 4733291 Compare October 16, 2023 20:28

renovate bot changed the title ~~fix(deps): update react-router monorepo to v6.17.0~~ fix(deps): update react-router monorepo to v6.18.0 Oct 31, 2023

renovate bot force-pushed the renovate/react-router-monorepo branch from 4733291 to e65fe9c Compare October 31, 2023 15:31

renovate bot changed the title ~~fix(deps): update react-router monorepo to v6.22.2~~ fix(deps): update react-router monorepo to v6.22.3 Mar 7, 2024

renovate bot force-pushed the renovate/react-router-monorepo branch from 26086f7 to 50c67d7 Compare April 23, 2024 16:17

renovate bot changed the title ~~fix(deps): update react-router monorepo to v6.22.3~~ fix(deps): update react-router monorepo to v6.23.0 Apr 23, 2024

renovate bot force-pushed the renovate/react-router-monorepo branch from 50c67d7 to faf4b41 Compare May 10, 2024 21:05

renovate bot changed the title ~~fix(deps): update react-router monorepo to v6.23.0~~ fix(deps): update react-router monorepo to v6.23.1 May 10, 2024

renovate bot force-pushed the renovate/react-router-monorepo branch from faf4b41 to 36bce69 Compare June 24, 2024 21:29

renovate bot changed the title ~~fix(deps): update react-router monorepo to v6.23.1~~ fix(deps): update react-router monorepo to v6.24.0 Jun 24, 2024

renovate bot force-pushed the renovate/react-router-monorepo branch from 36bce69 to 40bfeb8 Compare July 3, 2024 12:21

renovate bot changed the title ~~fix(deps): update react-router monorepo to v6.24.0~~ fix(deps): update react-router monorepo to v6.24.1 Jul 3, 2024

renovate bot force-pushed the renovate/react-router-monorepo branch from 40bfeb8 to c10f70d Compare July 16, 2024 14:53

renovate bot changed the title ~~fix(deps): update react-router monorepo to v6.24.1~~ fix(deps): update react-router monorepo to v6.25.0 Jul 16, 2024

renovate bot force-pushed the renovate/react-router-monorepo branch from c10f70d to 8f0fa58 Compare July 17, 2024 17:20

renovate bot changed the title ~~fix(deps): update react-router monorepo to v6.25.0~~ fix(deps): update react-router monorepo to v6.25.1 Jul 17, 2024

renovate bot force-pushed the renovate/react-router-monorepo branch from 8f0fa58 to 2b99af7 Compare August 1, 2024 13:52

renovate bot changed the title ~~fix(deps): update react-router monorepo to v6.25.1~~ fix(deps): update react-router monorepo to v6.26.0 Aug 1, 2024

renovate bot force-pushed the renovate/react-router-monorepo branch from 2b99af7 to 45ed55a Compare August 15, 2024 15:47

renovate bot changed the title ~~fix(deps): update react-router monorepo to v6.26.0~~ fix(deps): update react-router monorepo to v6.26.1 Aug 15, 2024

renovate bot force-pushed the renovate/react-router-monorepo branch from 45ed55a to 3979695 Compare September 9, 2024 15:43

renovate bot changed the title ~~fix(deps): update react-router monorepo to v6.26.1~~ fix(deps): update react-router monorepo to v6.26.2 Sep 9, 2024

renovate bot force-pushed the renovate/react-router-monorepo branch from 3979695 to 1ae9fa3 Compare October 11, 2024 21:04

renovate bot changed the title ~~fix(deps): update react-router monorepo to v6.26.2~~ fix(deps): update react-router monorepo to v6.27.0 Oct 11, 2024

renovate bot force-pushed the renovate/react-router-monorepo branch from 1ae9fa3 to 8bcf25b Compare November 7, 2024 01:28

renovate bot changed the title ~~fix(deps): update react-router monorepo to v6.27.0~~ fix(deps): update react-router monorepo to v6.28.0 Nov 7, 2024

renovate bot force-pushed the renovate/react-router-monorepo branch from 8bcf25b to 5e8b9bd Compare December 20, 2024 22:45

renovate bot changed the title ~~fix(deps): update react-router monorepo to v6.28.0~~ fix(deps): update react-router monorepo to v6.28.1 Dec 20, 2024

renovate bot force-pushed the renovate/react-router-monorepo branch from 5e8b9bd to b40c180 Compare January 16, 2025 16:48

renovate bot changed the title ~~fix(deps): update react-router monorepo to v6.28.1~~ fix(deps): update react-router monorepo to v6.28.2 Jan 16, 2025

fix(deps): update react-router monorepo to v6.29.0

97b6c37

renovate bot force-pushed the renovate/react-router-monorepo branch from b40c180 to 97b6c37 Compare January 30, 2025 19:30

renovate bot changed the title ~~fix(deps): update react-router monorepo to v6.28.2~~ fix(deps): update react-router monorepo to v6.29.0 Jan 30, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(deps): update react-router monorepo to v6.29.0 #28

fix(deps): update react-router monorepo to v6.29.0 #28

renovate bot commented Feb 18, 2023 •

edited

Loading

fix(deps): update react-router monorepo to v6.29.0 #28

Are you sure you want to change the base?

fix(deps): update react-router monorepo to v6.29.0 #28

Conversation

renovate bot commented Feb 18, 2023 • edited Loading

Release Notes

v6.29.0: v6.29.0

v6.28.2: v6.28.2

v6.28.1: v6.28.1

Minor Changes

Patch Changes

v6.27.0: v6.27.0

Patch Changes

Minor Changes

Patch Changes

v6.25.1: v6.25.1

Minor Changes

Patch Changes

Patch Changes

Minor Changes

Patch Changes

Patch Changes

Minor Changes

Patch Changes

Patch Changes

Patch Changes

v6.22.1: v6.22.1

Patch Changes

Patch Changes

Patch Changes

Minor Changes

Patch Changes

Patch Changes

Minor Changes

Patch Changes

Minor Changes

Patch Changes

Patch Changes

Patch Changes

Minor Changes

Patch Changes

Minor Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Minor Changes

Patch Changes

Patch Changes

Minor Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Minor Changes

Patch Changes

Minor Changes

Patch Changes

Patch Changes

Patch Changes

Patch 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

renovate bot commented Feb 18, 2023 •

edited

Loading

`v6.29.0`: v6.29.0

`v6.28.2`: v6.28.2

`v6.28.1`: v6.28.1

`v6.27.0`: v6.27.0

`v6.25.1`: v6.25.1

`v6.22.1`: v6.22.1