fix(deps): update react-router monorepo to v6.23.1 #4079

ScriptedAlchemy · 2024-06-21T09:54:09Z

This PR contains the following updates:

Package	Type	Update	Change
react-router (source)	dependencies	minor	`6.3.0` -> `6.23.1`
react-router-dom (source)	dependencies	minor	`6.3.0` -> `6.23.1`
react-router-dom (source)	devDependencies	minor	`6.5.0` -> `6.23.1`
react-router-dom (source)	dependencies	minor	`6.21.3` -> `6.23.1`
react-router-dom (source)	dependencies	minor	`6.10.0` -> `6.23.1`

Release Notes

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

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

Compare Source

Patch Changes

Fix encoding/decoding issues with pre-encoded dynamic parameter values (#11199)
Updated dependencies:
- @remix-run/router@1.15.1

`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

Patch Changes

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

`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 #11052 (comment)). 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

`v6.6.2`

Compare Source

Patch Changes

Ensure useId consistency during SSR (#9805)

`v6.6.1`

Compare Source

Patch Changes

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

`v6.6.0`

Compare Source

Patch Changes

Prevent useLoaderData usage in errorElement (#9735)
Updated dependencies:
- @remix-run/router@1.2.0

`v6.5.0`

Compare Source

This release introduces support for Optional Route Segments. Now, adding a ? to the end of any path segment will make that entire segment optional. This works for both static segments and dynamic parameters.

Optional Params Examples

<Route path=":lang?/about> will match:
- /:lang/about
- /about
<Route path="/multistep/:widget1?/widget2?/widget3?"> will match:
- /multistep
- /multistep/:widget1
- /multistep/:widget1/:widget2
- /multistep/:widget1/:widget2/:widget3

Optional Static Segment Example

<Route path="/home?"> will match:
- /
- /home
<Route path="/fr?/about"> will match:
- /about
- /fr/about

Minor Changes

Allows optional routes and optional static segments (#9650)

Patch Changes

Stop incorrectly matching on partial named parameters, i.e. <Route path="prefix-:param">, to align with how splat parameters work. If you were previously relying on this behavior then it's recommended to extract the static portion of the path at the useParams call site: (#9506)

// Old behavior at URL /prefix-123
<Route path="prefix-:id" element={<Comp /> }>

function Comp() {
  let params = useParams(); // { id: '123' }
  let id = params.id; // "123"
  ...
}

// New behavior at URL /prefix-123
<Route path=":id" element={<Comp /> }>

function Comp() {
  let params = useParams(); // { id: 'prefix-123' }
  let id = params.id.replace(/^prefix-/, ''); // "123"
  ...
}

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

`v6.4.5`

Compare Source

Patch Changes

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

`v6.4.4`

Compare Source

Patch Changes

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

`v6.4.3`

Compare Source

Patch Changes

useRoutes should be able to return null when passing locationArg (#9485)
fix initialEntries type in createMemoryRouter (#9498)
Updated dependencies:
- @remix-run/router@1.0.3

`v6.4.2`

Compare Source

Patch Changes

Fix IndexRouteObject and NonIndexRouteObject types to make hasErrorElement optional (#9394)
Enhance console error messages for invalid usage of data router hooks (#9311)
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)
Updated dependencies:
- @remix-run/router@1.0.2

`v6.4.1`

Compare Source

Patch Changes

Preserve state from initialEntries (#9288)
Updated dependencies:
- @remix-run/router@1.0.1

`v6.4.0`

Compare Source

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, especially the feature overview and the tutorial.

New APIs

Create your router with createMemoryRouter
Render your router with <RouterProvider>
Load data with a Route loader and mutate with a Route action
Handle errors with Route errorElement
Defer non-critical data with defer and Await

Bug Fixes

Path resolution is now trailing slash agnostic (#8861)
useLocation returns the scoped location inside a <Routes location> component (#9094)

Updated Dependencies

@remix-run/router@1.0.0

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

Patch Changes

Updated dependencies:
- react-router@6.22.1
- @remix-run/router@1.15.1

`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

Patch Changes

Leverage useId for internal fetcher keys when available (#11166)
Updated dependencies:
- @remix-run/router@1.14.2
- react-router@6.21.2

`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

Revert the useResolvedPath fix for splat routes due to a large number of applications that were relying on the buggy behavior (see #11052 (comment)). We plan to re-introduce this fix behind a future flag in the next minor version. (#11078)
Updated dependencies:
- react-router@6.20.1
- @remix-run/router@1.13.1

`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 s

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 has been generated by Renovate Bot.

vercel · 2024-06-21T09:54:13Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
medusa-example-dsl	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jun 22, 2024 6:25pm
medusa-example-home	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jun 22, 2024 6:25pm
medusa-example-nav	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jun 22, 2024 6:25pm
medusa-example-search	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jun 22, 2024 6:25pm
medusa-example-utils	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jun 22, 2024 6:25pm

github-actions · 2024-06-21T10:32:03Z

Workflow status is failure ❌
Unfortunately test report wasn't generated, it can be if no workspaces changed. Please check the workflow run below.
Link to GitHub workflow: Github Workflow Link

github-actions · 2024-06-22T18:20:43Z

Workflow status is success ✅
Unfortunately test report wasn't generated, it can be if no workspaces changed. Please check the workflow run below.
Link to GitHub workflow: Github Workflow Link

github-actions bot added the workflow-failure Workflow is failed label Jun 21, 2024

vercel bot deployed to Preview – medusa-example-search June 21, 2024 10:33 View deployment

vercel bot deployed to Preview – medusa-example-utils June 21, 2024 10:33 View deployment

vercel bot deployed to Preview – medusa-example-dsl June 21, 2024 10:35 View deployment

vercel bot deployed to Preview – medusa-example-nav June 21, 2024 10:36 View deployment

vercel bot deployed to Preview – medusa-example-home June 21, 2024 10:37 View deployment

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

fc1cc8c

ScriptedAlchemy force-pushed the renovate/react-router-monorepo branch from 6246975 to fc1cc8c Compare June 22, 2024 18:14

github-actions bot added workflow-success All good and removed workflow-failure Workflow is failed labels Jun 22, 2024

vercel bot deployed to Preview – medusa-example-utils June 22, 2024 18:21 View deployment

vercel bot deployed to Preview – medusa-example-search June 22, 2024 18:22 View deployment

vercel bot deployed to Preview – medusa-example-home June 22, 2024 18:23 View deployment

vercel bot deployed to Preview – medusa-example-nav June 22, 2024 18:24 View deployment

vercel bot deployed to Preview – medusa-example-dsl June 22, 2024 18:25 View deployment

ScriptedAlchemy merged commit 1f343c9 into master Jun 22, 2024
25 checks passed

ScriptedAlchemy deleted the renovate/react-router-monorepo branch June 22, 2024 18:37

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(deps): update react-router monorepo to v6.23.1 #4079

fix(deps): update react-router monorepo to v6.23.1 #4079

ScriptedAlchemy commented Jun 21, 2024 •

edited

Loading

vercel bot commented Jun 21, 2024 •

edited

Loading

github-actions bot commented Jun 21, 2024

github-actions bot commented Jun 22, 2024

fix(deps): update react-router monorepo to v6.23.1 #4079

fix(deps): update react-router monorepo to v6.23.1 #4079

Conversation

ScriptedAlchemy commented Jun 21, 2024 • edited Loading

Release Notes

Patch Changes

Minor Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

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

Patch Changes

Patch Changes

Patch Changes

Minor Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Minor Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Minor Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Minor Changes

Patch Changes

Patch Changes

Minor Changes

Patch Changes

Minor Changes

Patch Changes

Minor Changes

Patch Changes

Minor Changes

Configuration

ScriptedAlchemy commented Jun 21, 2024 •

edited

Loading

vercel bot commented Jun 21, 2024 •

edited

Loading