react-router-dom

Date: 2025-06-27

Patch Changes

• react-router - Do not serialize types for useRouteLoaderData<typeof clientLoader> (#13752)

  • For types to distinguish a clientLoader from a serverLoader, you MUST annotate clientLoader args:

    //                                   👇 annotation required to skip serializing types
    export function clientLoader({}: Route.ClientLoaderArgs) {
      return { fn: () => "earth" };
    }
    
    function SomeComponent() {
      const data = useRouteLoaderData<typeof clientLoader>("routes/this-route");
      const planet = data?.fn() ?? "world";
      return <h1>Hello, {planet}!</h1>;
    }
    

• @react-router/cloudflare - Remove tsup from peerDependencies (#13757)

• @react-router/dev - Add Vite 7 support (#13748)

• @react-router/dev - Skip package.json resolution checks when a custom entry.server.(j|t)sx file is provided (#13744)

• @react-router/dev - Add validation for a route's id not being 'root' (#13792)

• @react-router/fs-routes @react-router/remix-config-routes-adapter - Use replaceAll for normalizing windows file system slashes (#13738)

• @react-router/node - Remove old "install" package exports (#13762)

Full Changelog: v7.6.2...v7.6.3

Date: 2025-06-03

Patch Changes

• create-react-router - Update tar-fs (#13675)

• react-router - (INTERNAL) Slight refactor of internal headers() function processing for use with RSC (#13639)

• react-router @react-router/dev - Avoid additional with-props chunk in Framework Mode by moving route module component prop logic from the Vite plugin to react-router (#13650)

• @react-router/dev - When future.unstable_viteEnvironmentApi is enabled and an absolute Vite base has been configured, ensure critical CSS is handled correctly during development (#13598)

• @react-router/dev - Update vite-node (#13673)

• @react-router/dev - Fix typegen for non-{.js,.jsx,.ts,.tsx} routes like .mdx (#12453)

• @react-router/dev - Fix href types for optional dynamic params (#13725)

  7.6.1 introduced fixes for href when using optional static segments, but those fixes caused regressions with how optional dynamic params worked in 7.6.0:

  // 7.6.0
  href("/users/:id?"); // ✅
  href("/users/:id?", { id: 1 }); // ✅
  
  // 7.6.1
  href("/users/:id?"); // ❌
  href("/users/:id?", { id: 1 }); // ❌
  

  Now, optional static segments are expanded into different paths for href, but optional dynamic params are not. This way href can unambiguously refer to an exact URL path, all while keeping the number of path options to a minimum.

  // 7.6.2
  
  // path: /users/:id?/edit?
  href("
  //    ^ suggestions when cursor is here:
  //
  //    /users/:id?
  //    /users/:id?/edit
  

  Additionally, you can pass params from component props without needing to narrow them manually:

  declare const params: { id?: number };
  
  // 7.6.0
  href("/users/:id?", params);
  
  // 7.6.1
  href("/users/:id?", params); // ❌
  "id" in params ? href("/users/:id", params) : href("/users"); // works... but is annoying
  
  // 7.6.2
  href("/users/:id?", params); // restores behavior of 7.6.0
  

Full Changelog: v7.6.1...v7.6.2

Date: 2025-05-25

Patch Changes

• react-router - Partially revert optimization added in 7.1.4 to reduce calls to matchRoutes because it surfaced other issues (#13562)

• react-router - Update Route.MetaArgs to reflect that data can be potentially undefined (#13563)

  • This is primarily for cases where a route loader threw an error to it's own ErrorBoundary, but it also arises in the case of a 404 which renders the root ErrorBoundary/meta but the root loader did not run because not routes matched

• react-router - Avoid initial fetcher execution 404 error when Lazy Route Discovery is interrupted by a navigation (#13564)

• react-router - Properly href replaces splats * (#13593)

  • href("/products/*", { "*": "/1/edit" }); // -> /products/1/edit

• @react-router/architect - Update @architect/functions from ^5.2.0 to ^7.0.0 (#13556)

• @react-router/dev - Prevent typegen with route files that are outside the app/ directory (#12996)

• @react-router/dev - Add additional logging to build command output when cleaning assets from server build (#13547)

• @react-router/dev - Don't clean assets from server build when build.ssrEmitAssets has been enabled in Vite config (#13547)

• @react-router/dev - Fix typegen when same route is used at multiple paths (#13574)

  • For example, routes/route.tsx is used at 4 different paths here:

    import { type RouteConfig, route } from "@react-router/dev/routes";
    export default [
      route("base/:base", "routes/base.tsx", [
        route("home/:home", "routes/route.tsx", { id: "home" }),
        route("changelog/:changelog", "routes/route.tsx", { id: "changelog" }),
        route("splat/*", "routes/route.tsx", { id: "splat" }),
      ]),
      route("other/:other", "routes/route.tsx", { id: "other" }),
    ] satisfies RouteConfig;
    

  • Previously, typegen would arbitrarily pick one of these paths to be the "winner" and generate types for the route module based on that path

  • Now, typegen creates unions as necessary for alternate paths for the same route file

• @react-router/dev - Better types for params (#13543)

  • For example:

    // routes.ts
    import { type RouteConfig, route } from "@react-router/dev/routes";
    
    export default [
      route("parent/:p", "routes/parent.tsx", [
        route("route/:r", "routes/route.tsx", [
          route("child1/:c1a/:c1b", "routes/child1.tsx"),
          route("child2/:c2a/:c2b", "routes/child2.tsx"),
        ]),
      ]),
    ] satisfies RouteConfig;
    

  • Previously, params for routes/route were calculated as { p: string, r: string }.

  • This incorrectly ignores params that could come from child routes

  • If visiting /parent/1/route/2/child1/3/4, the actual params passed to routes/route will have a type of { p: string, r: string, c1a: string, c1b: string }

  • Now, params are aware of child routes and autocompletion will include child params as optionals:

    params.|
    //     ^ cursor is here and you ask for autocompletion
    // p: string
    // r: string
    // c1a?: string
    // c1b?: string
    // c2a?: string
    // c2b?: string
    

  • You can also narrow the types for params as it is implemented as a normalized union of params for each page that includes routes/route:

    if (typeof params.c1a === 'string') {
      params.|
      //     ^ cursor is here and you ask for autocompletion
      // p: string
      // r: string
      // c1a: string
      // c1b: string
    }
    

• @react-router/dev - Fix href for optional segments (#13595)

  • Type generation now expands paths with optionals into their corresponding non-optional paths

  • For example, the path /user/:id? gets expanded into /user and /user/:id to more closely model visitable URLs

  • href then uses these expanded (non-optional) paths to construct type-safe paths for your app:

    // original: /user/:id?
    // expanded: /user & /user/:id
    href("/user"); // ✅
    href("/user/:id", { id: 1 }); // ✅
    

  • This becomes even more important for static optional paths where there wasn't a good way to indicate whether the optional should be included in the resulting path:

    // original: /products/:id/detail?
    
    // before
    href("/products/:id/detail?"); // ❌ How can we tell `href` to include or omit `detail?` segment with a complex API?
    
    // now
    // expanded: /products/:id & /products/:id/detail
    href("/product/:id"); // ✅
    href("/product/:id/detail"); // ✅
    

Unstable Changes

⚠️ Unstable features are not recommended for production use

• @react-router/dev - Renamed internal react-router/route-module export to react-router/internal (#13543)
• @react-router/dev - Removed Info export from generated +types/* files (#13543)
• @react-router/dev - Normalize dirent entry path across node versions when generating SRI manifest (#13591)

Full Changelog: v7.6.0...v7.6.1

Date: 2025-05-08

What's Changed

routeDiscovery Config Option

We've added a new config option in 7.6.0 which grants you more control over the Lazy Route Discovery feature. You can now configure the /__manifest path if you're running multiple RR applications on the same server, or you can also disable the feature entirely if your application is small enough and the feature isn't necessary.

// react-router.config.ts

export default {
  // You can modify the manifest path used:
  routeDiscovery: { mode: "lazy", manifestPath: "/custom-manifest" }

  // Or you can disable this feature entirely and include all routes in the
  // manifest on initial document load:
  routeDiscovery: { mode: "initial" }

  // If you don't specify anything, the default config is as follows, which enables
  // Lazy Route Discovery and makes manifest requests to the `/__manifest` path:
  // routeDiscovery: { mode: "lazy", manifestPath: "/__manifest" }
} satisfies Config;

Automatic Types for Future Flags

Some future flags alter the way types should work in React Router. Previously, you had to remember to manually opt-in to the new types. For example, for future.unstable_middleware:

// react-router.config.ts

// Step 1: Enable middleware
export default {
  future: {
    unstable_middleware: true,
  },
};

// Step 2: Enable middleware types
declare module "react-router" {
  interface Future {
    unstable_middleware: true; // 👈 Enable middleware types
  }
}

It was up to you to keep the runtime future flags synced with the types for those flags. This was confusing and error-prone.

Now, React Router will automatically enable types for future flags. That means you only need to specify the runtime future flag:

// react-router.config.ts

// Step 1: Enable middleware
export default {
  future: {
    unstable_middleware: true,
  },
};

// No step 2! That's it!

Behind the scenes, React Router will generate the corresponding declare module into .react-router/types. Currently this is done in .react-router/types/+register.ts but this is an implementation detail that may change in the future.

Minor Changes

• react-router - Added a new routeDiscovery option in react-router.config.ts to configure Lazy Route Discovery behavior (#13451)

• react-router - Add support for route component props in createRoutesStub (#13528)

  • This allows you to unit test your route components using the props instead of the hooks:

    let RoutesStub = createRoutesStub([
      {
        path: "/",
        Component({ loaderData }) {
          let data = loaderData as { message: string };
          return <pre data-testid="data">Message: {data.message}</pre>;
        },
        loader() {
          return { message: "hello" };
        },
      },
    ]);
    
    render(<RoutesStub />);
    
    await waitFor(() => screen.findByText("Message: hello"));
    

• @react-router/dev - Automatic types for future flags (#13506)

Patch Changes

You may notice this list is a bit larger than usual! The team ate their vegetables last week and spent the week squashing bugs to work on lowering the issue count that had ballooned a bit since the v7 release.

• react-router - Fix react-router module augmentation for NodeNext (#13498)
• react-router - Don't bundle react-router in react-router/dom CJS export (#13497)
• react-router - Fix bug where a submitting fetcher would get stuck in a loading state if a revalidating loader redirected (#12873)
• react-router - Fix hydration error if a server loader returned undefined (#13496)
• react-router - Fix initial load 404 scenarios in data mode (#13500)
• react-router - Stabilize useRevalidator's revalidate function (#13542)
• react-router - Preserve status code if a clientAction throws a data() result in framework mode (#13522)
• react-router - Be defensive against leading double slashes in paths to avoid Invalid URL errors from the URL constructor (#13510)
  • Note we do not sanitize/normalize these paths - we only detect them so we can avoid the error that would be thrown by new URL("//", window.location.origin)
• react-router - Remove Navigator declaration for navigator.connection.saveData to avoid messing with any other types beyond saveData in user land (#13512)
• react-router - Fix handleError params values on .data requests for routes with a dynamic param as the last URL segment (#13481)
• react-router - Don't trigger an ErrorBoundary UI before the reload when we detect a manifest version mismatch in Lazy Route Discovery (#13480)
• react-router - Inline turbo-stream@2.4.1 dependency and fix decoding ordering of Map/Set instances (#13518)
• react-router - Only render dev warnings during dev (#13461)
• react-router - Short circuit post-processing on aborted dataStrategy requests (#13521)
  • This resolves non-user-facing console errors of the form Cannot read properties of undefined (reading 'result')
• @react-router/dev - Support project root directories without a package.json if it exists in a parent directory (#13472)
• @react-router/dev - When providing a custom Vite config path via the CLI --config/-c flag, default the project root directory to the directory containing the Vite config when not explicitly provided (#13472)
• @react-router/dev - In a routes.ts context, ensure the --mode flag is respected for import.meta.env.MODE (#13485)
  • Previously, import.meta.env.MODE within a routes.ts context was always "development" for the dev and typegen --watch commands, but otherwise resolved to "production". These defaults are still in place, but if a --mode flag is provided, this will now take precedence.
• @react-router/dev - Ensure consistent project root directory resolution logic in CLI commands (#13472)
• @react-router/dev - When executing react-router.config.ts and routes.ts with vite-node, ensure that PostCSS config files are ignored (#13489)
• @react-router/dev - When extracting critical CSS during development, ensure it's loaded from the client environment to avoid issues with plugins that handle the SSR environment differently (#13503)
• @react-router/dev - Fix "Status message is not supported by HTTP/2" error during dev when using HTTPS (#13460)
• @react-router/dev - Update config when react-router.config.ts is created or deleted during development (#12319)
• @react-router/dev - Skip unnecessary routes.ts evaluation before Vite build is started (#13513)
• @react-router/dev - Fix TS2300: Duplicate identifier errors caused by generated types (#13499)
• Previously, routes that had the same full path would cause duplicate entries in the generated types for href (.react-router/types/+register.ts), causing type checking errors

Unstable Changes

⚠️ Unstable features are not recommended for production use

• react-router - Fix a few bugs with error bubbling in middleware use-cases (#13538)
• @react-router/dev - When future.unstable_viteEnvironmentApi is enabled, ensure that build.assetsDir in Vite config is respected when environments.client.build.assetsDir is not configured (#13491)

Changes by Package

• create-react-router
• react-router
• @react-router/architect
• @react-router/cloudflare
• @react-router/dev
• @react-router/express
• @react-router/fs-routes
• @react-router/node
• @react-router/remix-config-routes-adapter
• @react-router/serve

Full Changelog: v7.5.3...v7.6.0

Date: 2025-04-28

Patch Changes

• react-router - Fix bug where bubbled action errors would result in loaderData being cleared at the handling ErrorBoundary route (#13476)
• react-router - Handle redirects from clientLoader.hydrate initial load executions (#13477)

Full Changelog: v7.5.2...v7.5.3

Date: 2025-04-24

Security Notice

Fixed 2 security vulnerabilities that could result in cache-poisoning attacks by sending specific headers intended for build-time usage for SPA Mode and Pre-rendering (GHSA-f46r-rw29-r322, GHSA-cpj6-fhp6-mr6j).

Patch Changes

• react-router - Adjust approach for Pre-rendering/SPA Mode via headers (#13453)
• react-router - Update Single Fetch to also handle the 204 redirects used in ?_data requests in Remix v2 (#13364)
  • This allows applications to trigger a redirect on .data requests from outside the scope of React Router (i.e., an express/hono middleware) the same way they did in Remix v2 before Single Fetch was implemented
  • This is a bit of an escape hatch - the recommended way to handle this is redirecting from a root route middleware
  • To use this functionality, you may return from a .data request wih a response as follows:
    • Set a 204 status code
    • Set an X-Remix-Redirect: <new-location> header
    • Optionally, set X-Remix-Replace: true or X-Remix-Reload-Document: true headers to replicate replace()/redirectDocument() functionality
  • ⚠️ Please note that these responses rely on implementation details that are subject to change without a SemVer major release, and it is recommended you set up integration tests for your application to confirm this functionality is working correctly with each future React Router upgrade

Full Changelog: v7.5.1...v7.5.2

Date: 2025-04-17

Patch Changes

• react-router - When using the object-based route.lazy API, the HydrateFallback and hydrateFallbackElement properties are now skipped when lazy loading routes after hydration (#13376)

  • If you move the code for these properties into a separate file, since the hydrate properties were unused already (if the route wasn't present during hydration), you can avoid downloading them at all. For example:

    createBrowserRouter([
      {
        path: "/show/:showId",
        lazy: {
          loader: async () => (await import("./show.loader.js")).loader,
          Component: async () =>
            (await import("./show.component.js")).Component,
          HydrateFallback: async () =>
            (await import("./show.hydrate-fallback.js")).HydrateFallback,
        },
      },
    ]);
    

• react-router - Fix single fetch bug where no revalidation request would be made when navigating upwards to a reused parent route (#13253)

• react-router - Properly revalidate pre-rendered paths when param values change when using ssr:false + prerender configs (#13380)

• react-router - Fix pre-rendering when a loader returns a redirect (#13365)

• react-router - Do not automatically add null to staticHandler.query() context.loaderData if routes do not have loaders (#13223)

  • This was a Remix v2 implementation detail inadvertently left in for React Router v7
  • Now that we allow returning undefined from loaders, our prior check of loaderData[routeId] !== undefined was no longer sufficient and was changed to a routeId in loaderData check - these null values can cause issues for this new check
  • ⚠️ This could be a "breaking bug fix" for you if you are doing manual SSR with createStaticHandler()/<StaticRouterProvider>, and using context.loaderData to control <RouterProvider> hydration behavior on the client

Unstable Changes

⚠️ Unstable features are not recommended for production use

• react-router - Add better error messaging when getLoadContext is not updated to return a Map (#13242)
• react-router - Update context type for LoaderFunctionArgs/ActionFunctionArgs when middleware is enabled (#13381)
• react-router - Add a new unstable_runClientMiddleware argument to dataStrategy to enable middleware execution in custom dataStrategy implementations (#13395)
• react-router - Add support for the new unstable_shouldCallHandler/unstable_shouldRevalidateArgs APIs in dataStrategy (#13253)

Full Changelog: v7.5.0...v7.5.1

Date: 2025-04-04

What's Changed

route.lazy Object API

We've introduced a new route.lazy API which gives you more granular control over the lazy loading of route properties that you could not achieve with the route.lazy() function signature. This is useful for Framework mode and performance-critical library mode applications.

createBrowserRouter([
  {
    path: "/show/:showId",
    lazy: {
      loader: async () => (await import("./show.loader.js")).loader,
      action: async () => (await import("./show.action.js")).action,
      Component: async () => (await import("./show.component.js")).Component,
    },
  },
]);

⚠️ This is a breaking change if you have adopted the route.unstable_lazyMiddleware API which has been removed in favor of route.lazy.unstable_middleware. See the Unstable Changes section below for more information.

Minor Changes

• react-router - Add granular object-based API for route.lazy to support lazy loading of individual route properties (#13294)

Patch Changes

• @react-router/dev - Update optional wrangler peer dependency range to support wrangler v4 (#13258)
• @react-router/dev - Reinstate dependency optimization in the child compiler to fix depsOptimizer is required in dev mode errors when using vite-plugin-cloudflare and importing Node.js builtins (#13317)

Unstable Changes

⚠️ Unstable features are not recommended for production use

• react-router - Introduce future.unstable_subResourceIntegrity flag that enables generation of an importmap with integrity for the scripts that will be loaded by the browser (#13163)
• react-router - Remove support for the route.unstable_lazyMiddleware property (#13294)
  • In order to lazily load middleware, you can use the new object-based route.lazy.unstable_middleware API
• @react-router/dev - When future.unstable_viteEnvironmentApi is enabled, ensure critical CSS in development works when using a custom Vite base has been configured (#13305)

Changes by Package

• create-react-router
• react-router
• @react-router/architect
• @react-router/cloudflare
• @react-router/dev
• @react-router/express
• @react-router/fs-routes
• @react-router/node
• @react-router/remix-config-routes-adapter
• @react-router/serve

Full Changelog: v7.4.1...v7.5.0

Date: 2025-03-28

Security Notice

Fixed a security vulnerability that allowed URL manipulation and potential cache pollution via the Host and X-Forwarded-Host headers due to inadequate port sanitization (GHSA-4q56-crqp-v477/CVE-2025-31137).

Patch Changes

• react-router - Dedupe calls to route.lazy functions (#13260)
• @react-router/dev - Fix path in prerender error messages (#13257)
• @react-router/dev - Fix typegen for virtual modules when moduleDetection is set to force (#13267)
• @react-router/express - Better validation of x-forwarded-host header to prevent potential security issues (#13309)

Unstable Changes

⚠️ Unstable features are not recommended for production use

• react-router - Fix types on unstable_MiddlewareFunction to avoid type errors when a middleware doesn't return a value (#13311)
• react-router - Add support for route.unstable_lazyMiddleware function to allow lazy loading of middleware logic (#13210)
  • ⚠️ We do not recommend adoption of this API currently as we are likely going to change it prior to the stable release of middleware
  • ⚠️ This may be a breaking change if your app is currently returning unstable_middleware from route.lazy
  • The route.unstable_middleware property is no longer supported in the return value from route.lazy
  • If you want to lazily load middleware, you must use route.unstable_lazyMiddleware
• @react-router/dev - When both future.unstable_middleware and future.unstable_splitRouteModules are enabled, split unstable_clientMiddleware route exports into separate chunks when possible (#13210)
• @react-router/dev - Improve performance of future.unstable_middleware by ensuring that route modules are only blocking during the middleware phase when the unstable_clientMiddleware has been defined (#13210)

Full Changelog: v7.4.0...v7.4.1

Date: 2025-03-19

Minor Changes

• @react-router/dev - Generate types for virtual:react-router/server-build module (#13152)

Patch Changes

• react-router - Fix root loader data on initial load redirects in SPA mode (#13222)
• react-router - Load ancestor pathless/index routes in lazy route discovery for upwards non-eager-discovery routing (#13203)
• react-router - Fix shouldRevalidate behavior for clientLoader-only routes in ssr:true apps (#13221)
• @react-router/dev - Fix conflicts with other Vite plugins that use the configureServer and/or configurePreviewServer hooks (#13184)

Unstable Changes

⚠️ Unstable features are not recommended for production use

• react-router - If a middleware throws an error, ensure we only bubble the error itself via next() and are no longer leaking the MiddlewareError implementation detail (#13180)
  • ⚠️ This may be a breaking change if you are catch-ing errors thrown by the next() function in your middlewares
• react-router - Fix RequestHandler loadContext parameter type when middleware is enabled (#13204)
• react-router - Update Route.unstable_MiddlewareFunction to have a return value of Response | undefined instead of Response | void (#13199)
• @react-router/dev - When future.unstable_splitRouteModules is set to "enforce", allow both splittable and unsplittable root route exports since it's always in a single chunk (#13238)
• @react-router/dev - When future.unstable_viteEnvironmentApi is enabled, allow plugins that override the default SSR environment (such as @cloudflare/vite-plugin) to be placed before or after the React Router plugin (#13183)

Changes by Package

• create-react-router
• react-router
• @react-router/architect
• @react-router/cloudflare
• @react-router/dev
• @react-router/express
• @react-router/fs-routes
• @react-router/node
• @react-router/remix-config-routes-adapter
• @react-router/serve

Full Changelog: v7.3.0...v7.4.0

Date: 2025-03-06

Minor Changes

• Add fetcherKey as a parameter to patchRoutesOnNavigation (#13061)

Patch Changes

• react-router - Detect and handle manifest-skew issues on new deploys during active sessions (#13061)
  • In framework mode, Lazy Route Discovery will now detect manifest version mismatches in active sessions after a new deploy
  • On navigations to undiscovered routes, this mismatch will trigger a document reload of the destination path
  • On fetcher calls to undiscovered routes, this mismatch will trigger a document reload of the current path
• react-router - Skip resource route flow in dev server in SPA mode (#13113)
• react-router - Fix single fetch _root.data requests when a basename is used (#12898)
• react-router - Fix types for loaderData and actionData that contained Records (#13139)
  • ⚠️ This is a breaking change for users who have already adopted unstable_SerializesTo - see the note in the Unstable Changes section below for more information
• @react-router/dev - Fix support for custom client build.rollupOptions.output.entryFileNames (#13098)
• @react-router/dev - Fix usage of prerender option when serverBundles option has been configured or provided by a preset, e.g. vercelPreset from @vercel/react-router (#13082)
• @react-router/dev - Fix support for custom build.assetsDir (#13077)
• @react-router/dev - Remove unused dependencies (#13134)
• @react-router/dev - Stub all routes except root in "SPA Mode" server builds to avoid issues when route modules or their dependencies import non-SSR-friendly modules (#13023)
• @react-router/dev - Remove unused Vite file system watcher (#13133)
• @react-router/dev - Fix support for custom SSR build input when serverBundles option has been configured (#13107)
  • ⚠️ Note that for consumers using the future.unstable_viteEnvironmentApi and serverBundles options together, hyphens are no longer supported in server bundle IDs since they also need to be valid Vite environment names.
• @react-router/dev - Fix dev server when using HTTPS by stripping HTTP/2 pseudo headers from dev server requests (#12830)
• @react-router/dev - Lazy load Cloudflare platform proxy on first dev server request when using the cloudflareDevProxy Vite plugin to avoid creating unnecessary workerd processes (#13016)
• @react-router/dev - Fix duplicated entries in typegen for layout routes and their corresponding index route (#13140)
• @react-router/express - Update express peerDependency to include v5 (https://github.com/remix-run/react-router/pull/13064) (#12961)

Unstable Changes

⚠️ Unstable features are not recommended for production use

• react-router - Add context support to client side data routers (unstable) (#12941)
• react-router - Support middleware on routes (unstable) (#12941)
• @react-router/dev - Fix errors with future.unstable_viteEnvironmentApi when the ssr environment has been configured by another plugin to be a custom Vite.DevEnvironment rather than the default Vite.RunnableDevEnvironment (#13008)
• @react-router/dev - When future.unstable_viteEnvironmentApi is enabled and the ssr environment has optimizeDeps.noDiscovery disabled, define optimizeDeps.entries and optimizeDeps.include (#13007)

Client-side context (unstable)

Your application clientLoader/clientAction functions (or loader/action in library mode) will now receive a context parameter on the client. This is an instance of unstable_RouterContextProvider that you use with type-safe contexts (similar to React.createContext) and is most useful with the corresponding unstable_clientMiddleware API:

import { unstable_createContext } from "react-router";

type User = {
  /*...*/
};

const userContext = unstable_createContext<User>();

const sessionMiddleware: Route.unstable_ClientMiddlewareFunction = async ({
  context,
}) => {
  let user = await getUser();
  context.set(userContext, user);
};

export const unstable_clientMiddleware = [sessionMiddleware];

export function clientLoader({ context }: Route.ClientLoaderArgs) {
  let user = context.get(userContext);
  let profile = await getProfile(user.id);
  return { profile };
}

Similar to server-side requests, a fresh context will be created per navigation (or fetcher call). If you have initial data you'd like to populate in the context for every request, you can provide an unstable_getContext function at the root of your app:

• Library mode - createBrowserRouter(routes, { unstable_getContext })
• Framework mode - <HydratedRouter unstable_getContext>

This function should return an value of type unstable_InitialContext which is a Map<unstable_RouterContext, unknown> of context's and initial values:

const loggerContext = unstable_createContext<(...args: unknown[]) => void>();

function logger(...args: unknown[]) {
  console.log(new Date.toISOString(), ...args);
}

function unstable_getContext() {
  let map = new Map();
  map.set(loggerContext, logger);
  return map;
}

Middleware (unstable)

Middleware is implemented behind a future.unstable_middleware flag. To enable, you must enable the flag and the types in your react-router.config.ts file:

import type { Config } from "@react-router/dev/config";
import type { Future } from "react-router";

declare module "react-router" {
  interface Future {
    unstable_middleware: true; // 👈 Enable middleware types
  }
}

export default {
  future: {
    unstable_middleware: true, // 👈 Enable middleware
  },
} satisfies Config;

⚠️ Middleware is unstable and should not be adopted in production. There is at least one known de-optimization in route module loading for clientMiddleware that we will be addressing this before a stable release.

⚠️ Enabling middleware contains a breaking change to the context parameter passed to your loader/action functions - see below for more information.

Once enabled, routes can define an array of middleware functions that will run sequentially before route handlers run. These functions accept the same parameters as loader/action plus an additional next parameter to run the remaining data pipeline. This allows middlewares to perform logic before and after handlers execute.

// Framework mode
export const unstable_middleware = [serverLogger, serverAuth]; // server
export const unstable_clientMiddleware = [clientLogger]; // client

// Library mode
const routes = [
  {
    path: "/",
    // Middlewares are client-side for library mode SPA's
    unstable_middleware: [clientLogger, clientAuth],
    loader: rootLoader,
    Component: Root,
  },
];

Here's a simple example of a client-side logging middleware that can be placed on the root route:

const clientLogger: Route.unstable_ClientMiddlewareFunction = async (
  { request },
  next,
) => {
  let start = performance.now();

  // Run the remaining middlewares and all route loaders
  await next();

  let duration = performance.now() - start;
  console.log(`Navigated to ${request.url} (${duration}ms)`);
};

Note that in the above example, the next/middleware functions don't return anything. This is by design as on the client there is no "response" to send over the network like there would be for middlewares running on the server. The data is all handled behind the scenes by the stateful router.

For a server-side middleware, the next function will return the HTTP Response that React Router will be sending across the wire, thus giving you a chance to make changes as needed. You may throw a new response to short circuit and respond immediately, or you may return a new or altered response to override the default returned by next().

const serverLogger: Route.unstable_MiddlewareFunction = async (
  { request, params, context },
  next,
) => {
  let start = performance.now();

  // 👇 Grab the response here
  let res = await next();

  let duration = performance.now() - start;
  console.log(`Navigated to ${request.url} (${duration}ms)`);

  // 👇 And return it here (optional if you don't modify the response)
  return res;
};

You can throw a redirect from a middleware to short circuit any remaining processing:

import { sessionContext } from "../context";
const serverAuth: Route.unstable_MiddlewareFunction = (
  { request, params, context },
  next,
) => {
  let session = context.get(sessionContext);
  let user = session.get("user");
  if (!user) {
    session.set("returnTo", request.url);
    throw redirect("/login", 302);
  }
};

Note that in cases like this where you don't need to do any post-processing you don't need to call the next function or return a Response.

Here's another example of using a server middleware to detect 404s and check the CMS for a redirect:

const redirects: Route.unstable_MiddlewareFunction = async ({
  request,
  next,
}) => {
  // attempt to handle the request
  let res = await next();

  // if it's a 404, check the CMS for a redirect, do it last
  // because it's expensive
  if (res.status === 404) {
    let cmsRedirect = await checkCMSRedirects(request.url);
    if (cmsRedirect) {
      throw redirect(cmsRedirect, 302);
    }
  }

  return res;
};

For more information on the middleware API/design, please see the decision doc.

Middleware context parameter

When middleware is enabled, your application will use a different type of context parameter in your loaders and actions to provide better type safety. Instead of AppLoadContext, context will now be an instance of ContextProvider that you can use with type-safe contexts (similar to React.createContext):

import { unstable_createContext } from "react-router";
import { Route } from "./+types/root";
import type { Session } from "./sessions.server";
import { getSession } from "./sessions.server";

let sessionContext = unstable_createContext<Session>();

const sessionMiddleware: Route.unstable_MiddlewareFunction = ({
  context,
  request,
}) => {
  let session = await getSession(request);
  context.set(sessionContext, session);
  //                          ^ must be of type Session
};

// ... then in some downstream middleware
const loggerMiddleware: Route.unstable_MiddlewareFunction = ({
  context,
  request,
}) => {
  let session = context.get(sessionContext);
  //  ^ typeof Session
  console.log(session.get("userId"), request.method, request.url);
};

// ... or some downstream loader
export function loader({ context }: Route.LoaderArgs) {
  let session = context.get(sessionContext);
  let profile = await getProfile(session.get("userId"));
  return { profile };
}

If you are using a custom server with a getLoadContext function, the return value for initial context values passed from the server adapter layer is no longer an object and should now return an unstable_InitialContext (Map<RouterContext, unknown>):

let adapterContext = unstable_createContext<MyAdapterContext>();

function getLoadContext(req, res): unstable_InitialContext {
  let map = new Map();
  map.set(adapterContext, getAdapterContext(req));
  return map;
}

unstable_SerializesTo

unstable_SerializesTo added a way to register custom serialization types in Single Fetch for other library and framework authors like Apollo. It was implemented with branded type whose branded property that was made optional so that casting arbitrary values was easy:

// without the brand being marked as optional
let x1 = 42 as unknown as unstable_SerializesTo<number>;
//          ^^^^^^^^^^

// with the brand being marked as optional
let x2 = 42 as unstable_SerializesTo<number>;

However, this broke type inference in loaderData and actionData for any Record types as those would now (incorrectly) match unstable_SerializesTo. This affected all users, not just those that depended on unstable_SerializesTo. To fix this, the branded property of unstable_SerializesTo is marked as required instead of optional.

For library and framework authors using unstable_SerializesTo, you may need to add as unknown casts before casting to unstable_SerializesTo.

Changes by Package

• create-react-router
• react-router
• @react-router/architect
• @react-router/cloudflare
• @react-router/dev
• @react-router/express
• @react-router/fs-routes
• @react-router/node
• @react-router/remix-config-routes-adapter
• @react-router/serve

Full Changelog: v7.2.0...v7.3.0

Date: 2025-02-18

What's Changed

Type-safe href utility

In framework mode, we now provide you with a fully type-safe href utility to give you all the warm and fuzzy feelings of path auto-completion and param validation for links in your application:

import { href } from "react-router";

export default function Component() {
  const link = href("/blog/:slug", { slug: "my-first-post" });
  //                ^ type-safe!     ^ Also type-safe!

  return (
    <main>
      <Link to={href("/products/:id", { id: "asdf" })} />
      <NavLink to={href("/:lang?/about", { lang: "en" })} />
    </main>
  );
}

You'll now get type errors if you pass a bad path value or a bad param value:

const badPath = href("/not/a/valid/path");
//                   ^ Error!

const badParam = href("/blog/:slug", { oops: "bad param" });
//                                     ^ Error!

Prerendering with a SPA Fallback

This release enhances the ability to use a combination of pre-rendered paths alongside other paths that operate in "SPA Mode" when pre-rendering with ssr:false.

• If you specify ssr:false without a prerender config, this is considered "SPA Mode" and the generated index.html file will only render down to the root route and will be able to hydrate for any valid application path
• If you specify ssr:false with a prerender config but do not include the / path (i.e., prerender: ['/blog/post']), then we still generate a "SPA Mode" index.html file that can hydrate for any path in the application
• If you specify ssr:false and include the / path in your prerender config, the generated index.html file will be specific to the root index route, so we will now also generate a separate "SPA Mode" file in __spa-fallback.html that you can serve/hydrate for non-prerendered paths

For more info, see the Pre-rendering docs for more info.

Allow a root loader in SPA Mode

SPA Mode used to prohibit the use of loaders in all routes so that we could hydrate for any path in the application. However, because the root route is always rendered at build time, we can lift this restriction for the root route.

In order to use your build-time loader data during pre-rendering, we now also expose the loaderData as an optional prop for the HydrateFallback component on routes:

• This will be defined so long as the HydrateFallback is rendering because children routes are loading
• This will be undefined if the HydrateFallback is rendering because the route itself has it's own hydrating clientLoader
  • In SPA mode, this will allow you to render loader root data into the SPA Mode HTML file

Minor Changes

• react-router - New type-safe href utility that guarantees links point to actual paths in your app (#13012)
• @react-router/dev - Generate a "SPA fallback" HTML file when pre-rendering the / route with ssr:false (#12948)
• @react-router/dev - Allow a loader in the root route in SPA mode because it can be called/server-rendered at build time (#12948)
  • Route.HydrateFallbackProps now also receives loaderData

Patch Changes

• react-router - Disable Lazy Route Discovery for all ssr:false apps and not just "SPA Mode" because there is no runtime server to serve the search-param-configured __manifest requests (#12894)
  • We previously only disabled this for "SPA Mode" but we realized it should apply to all ssr:false apps
  • In those prerender scenarios we would pre-render the /__manifest file but that makes some unnecessary assumptions about the static file server behaviors
• react-router - Don't apply Single Fetch revalidation de-optimization when in SPA mode since there is no server HTTP request (#12948)
• react-router - Properly handle revalidations to across a pre-render/SPA boundary (#13021)
  • In "hybrid" applications where some routes are pre-rendered and some are served from a SPA fallback, we need to avoid making .data requests if the path wasn't pre-rendered because the request will 404
  • We don't know all the pre-rendered paths client-side, however:
    • All loader data in ssr:false mode is static because it's generated at build time
    • A route must use a clientLoader to do anything dynamic
    • Therefore, if a route only has a loader and not a clientLoader, we disable revalidation by default because there is no new data to retrieve
    • We short circuit and skip single fetch .data request logic if there are no server loaders with shouldLoad=true in our single fetch dataStrategy
    • This ensures that the route doesn't cause a .data request that would 404 after a submission
• react-router - Align dev server behavior with static file server behavior when ssr:false is set (#12948)
  • When no prerender config exists, only SSR down to the root HydrateFallback (SPA Mode)
  • When a prerender config exists but the current path is not pre-rendered, only SSR down to the root HydrateFallback (SPA Fallback)
  • Return a 404 on .data requests to non-pre-rendered paths
• react-router - Improve prefetch performance of CSS side effects in framework mode (#12889)
• react-router - Properly handle interrupted manifest requests in lazy route discovery (#12915)
• @react-router/dev - Handle custom envDir in Vite config (#12969)
• @react-router/dev - Fix CLI parsing to allow argument-less npx react-router usage (#12925)
• @react-router/dev - Skip action-only resource routes when using prerender:true (#13004)
• @react-router/dev - Enhance invalid export detection when using ssr:false (#12948)
  • headers/action functions are prohibited in all routes with ssr:false because there will be no runtime server on which to run them
  • loader functions are more nuanced and depend on whether a given route is prerendered
    • When using ssr:false without a prerender config, only the root route can have a loader
    • When using ssr:false with a prerender config, only routes matched by a prerender path can have a loader
• @react-router/dev - Error at build time in ssr:false + prerender apps for the edge case scenario of: (#13021)
  • A parent route has only a loader (does not have a clientLoader)
  • The parent route is pre-rendered
  • The parent route has children routes which are not prerendered
  • This means that when the child paths are loaded via the SPA fallback, the parent won't have any loaderData because there is no server on which to run the loader
  • This can be resolved by either adding a parent clientLoader or pre-rendering the child paths
  • If you add a clientLoader, calling the serverLoader() on non-prerendered paths will throw a 404
• @react-router/dev - Limit prerendered resource route .data files to only the target route (#13004)
• @react-router/dev - Fix pre-rendering of binary files (#13039)
• @react-router/dev - Fix typegen for repeated params (#13012)
  • In React Router, path parameters are keyed by their name, so for a path pattern like /a/:id/b/:id?/c/:id, the last :id will set the value for id in useParams and the params prop
    • For example, /a/1/b/2/c/3 will result in the value { id: 3 } at runtime
  • Previously, generated types for params incorrectly modeled repeated params with an array
    • For example, /a/1/b/2/c/3 generated a type like { id: [1,2,3] }.
  • To be consistent with runtime behavior, the generated types now correctly model the "last one wins" semantics of path parameters.
    • For example, /a/1/b/2/c/3 now generates a type like { id: 3 }.
• @react-router/dev - Fix path to load package.json for react-router --version (#13012)

Unstable Changes

⚠️ Unstable features are not recommended for production use

• react-router - Add unstable_SerializesTo brand type for library authors to register types serializable by React Router's streaming format (turbo-stream) (#12264)
• @react-router/dev - Add unstable support for splitting route modules in framework mode via future.unstable_splitRouteModules (#11871)
• @react-router/dev - Add future.unstable_viteEnvironmentApi flag to enable experimental Vite Environment API support (#12936)

Split Route Modules (unstable)

⚠️ This feature is currently unstable, enabled by the future.unstable_splitRouteModules flag. We’d love any interested users to play with it locally and provide feedback, but we do not recommend using it in production yet.

If you do choose to adopt this flag in production, please ensure you do sufficient testing against your production build to ensure that the optimization is working as expected.

One of the conveniences of the Route Module API is that everything a route needs is in a single file. Unfortunately this comes with a performance cost in some cases when using the clientLoader, clientAction, and HydrateFallback APIs.

As a basic example, consider this route module:

import { MassiveComponent } from "~/components";

export async function clientLoader() {
  return await fetch("https://example.com/api").then((response) =>
    response.json(),
  );
}

export default function Component({ loaderData }) {
  return <MassiveComponent data={loaderData} />;
}

In this example we have a minimal clientLoader export that makes a basic fetch call, whereas the default component export is much larger. This is a problem for performance because it means that if we want to navigate to this route client-side, the entire route module must be downloaded before the client loader can start running.

To visualize this as a timeline:

<docs-info>In the following timeline diagrams, different characters are used within the Route Module bars to denote the different Route Module APIs being exported.</docs-info>

Get Route Module:  |--=======|
Run clientLoader:            |-----|
Render:                            |-|

Instead, we want to optimize this to the following:

Get clientLoader:  |--|
Get Component:     |=======|
Run clientLoader:     |-----|
Render:                     |-|

To achieve this optimization, React Router will split the route module into multiple smaller modules during the production build process. In this case, we'll end up with two separate virtual modules — one for the client loader and one for the component and its dependencies.

export async function clientLoader() {
  return await fetch("https://example.com/api").then((response) =>
    response.json(),
  );
}

import { MassiveComponent } from "~/components";

export default function Component({ loaderData }) {
  return <MassiveComponent data={loaderData} />;
}

💡 This optimization is automatically applied in framework mode, but you can also implement it in library mode via route.lazy and authoring your route in multiple files as covered in our blog post on lazy loading route modules.

Now that these are available as separate modules, the client loader and the component can be downloaded in parallel. This means that the client loader can be executed as soon as it's ready without having to wait for the component.

This optimization is even more pronounced when more Route Module APIs are used. For example, when using clientLoader, clientAction and HydrateFallback, the timeline for a single route module during a client-side navigation might look like this:

Get Route Module:     |--~~++++=======|
Run clientLoader:                     |-----|
Render:                                     |-|

This would instead be optimized to the following:

Get clientLoader:     |--|
Get clientAction:     |~~|
Get HydrateFallback:  SKIPPED
Get Component:        |=======|
Run clientLoader:        |-----|
Render:                        |-|

Note that this optimization only works when the Route Module APIs being split don't share code within the same file. For example, the following route module can't be split:

import { MassiveComponent } from "~/components";

const shared = () => console.log("hello");

export async function clientLoader() {
  shared();
  return await fetch("https://example.com/api").then((response) =>
    response.json(),
  );
}

export default function Component({ loaderData }) {
  shared();
  return <MassiveComponent data={loaderData} />;
}

This route will still work, but since both the client loader and the component depend on the shared function defined within the same file, it will be de-optimized into a single route module.

To avoid this, you can extract any code shared between exports into a separate file. For example:

export const shared = () => console.log("hello");

You can then import this shared code in your route module without triggering the de-optimization:

import { MassiveComponent } from "~/components";
import { shared } from "./shared";

export async function clientLoader() {
  shared();
  return await fetch("https://example.com/api").then((response) =>
    response.json(),
  );
}

export default function Component({ loaderData }) {
  shared();
  return <MassiveComponent data={loaderData} />;
}

Since the shared code is in its own module, React Router is now able to split this route module into two separate virtual modules:

import { shared } from "./shared";

export async function clientLoader() {
  shared();
  return await fetch("https://example.com/api").then((response) =>
    response.json(),
  );
}

import { MassiveComponent } from "~/components";
import { shared } from "./shared";

export default function Component({ loaderData }) {
  shared();
  return <MassiveComponent data={loaderData} />;
}

If your project is particularly performance sensitive, you can set the unstable_splitRouteModules future flag to "enforce":

export default {
  future: {
    unstable_splitRouteModules: "enforce",
  },
};

This setting will raise an error if any route modules can't be split:

Error splitting route module: routes/example/route.tsx

- clientLoader

This export could not be split into its own chunk because it shares code with other exports. You should extract any shared code into its own module and then import it within the route module.

Changes by Package

• create-react-router
• react-router
• @react-router/architect
• @react-router/cloudflare
• @react-router/dev
• @react-router/express
• @react-router/fs-routes
• @react-router/node
• @react-router/remix-config-routes-adapter
• @react-router/serve

Full Changelog: v7.1.5...v7.2.0

Date: 2025-01-31

Patch Changes

• react-router - Fix regression introduced in 7.1.4 via #12800 that caused issues navigating to hash routes inside splat routes for applications using Lazy Route Discovery (patchRoutesOnNavigation) (#12927)

Full Changelog: v7.1.4...v7.1.5

Date: 2025-01-30

Patch Changes

• @react-router/dev - Properly resolve Windows file paths to scan for Vite's dependency optimization when using the unstable_optimizeDeps future flag (#12637)
• @react-router/dev - Fix prerendering when using a custom server - previously we ended up trying to import the users custom server when we actually want to import the virtual server build module (#12759)
• react-router - Properly handle status codes that cannot have a body in single fetch responses (204, etc.) (#12760)
• react-router - Properly bubble headers as errorHeaders when throwing a data() result (#12846)
  • Avoid duplication of Set-Cookie headers if also returned from headers
• react-router - Stop erroring on resource routes that return raw strings/objects and instead serialize them as text/plain or application/json responses (#12848)
  • This only applies when accessed as a resource route without the .data extension
  • When accessed from a Single Fetch .data request, they will still be encoded via turbo-stream
• react-router - Optimize Lazy Route Discovery path discovery to favor a single querySelectorAll call at the body level instead of many calls at the sub-tree level (#12731)
• react-router - Optimize route matching by skipping redundant matchRoutes calls when possible (#12800, #12882)
• react-router - Internal reorg to clean up some duplicated route module types (#12799)

Full Changelog: v7.1.3...v7.1.4

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

Date: 2025-01-16

Patch Changes

• react-router - Fix issue with fetcher data cleanup in the data layer on fetcher unmount (#12681)
• react-router - Do not rely on symbol for filtering out redirect responses from loader data (#12694)
  • Previously, some projects were getting type checking errors like:

    error TS4058: Return type of exported function has or is using name 'redirectSymbol' from external module "node_modules/..." but cannot be named.
    

  • Now that symbols are not used for the redirect response type, these errors should no longer be present
• @react-router/dev - Fix default external conditions in Vite v6 (#12644)
  • This fixes resolution issues with certain npm packages
• @react-router/dev - Fix mismatch in prerendering html/data files when path is missing a leading slash (#12684)
• @react-router/dev - Use module-sync server condition when enabled in the runtime. This fixes React context mismatches (e.g. useHref() may be used only in the context of a <Router> component.) during development on Node 22.10.0+ when using libraries that have a peer dependency on React Router (#12729)
• @react-router/dev - Fix react-refresh source maps (#12686)

Full Changelog: v7.1.1...v7.1.2

Date: 2024-12-23

Patch Changes

• @react-router/dev - Fix for a crash when optional args are passed to the CLI (#12609)

Full Changelog: v7.1.0...v7.1.1

Date: 2024-12-20

Minor Changes

• Add support for Vite v6 (#12469)

Patch Changes

• react-router - Throw unwrapped Single Fetch redirect to align with pre-Single Fetch behavior (#12506)
• react-router - Ignore redirects when inferring loader data types (#12527)
• react-router - Remove <Link prefetch> warning which suffers from false positives in a lazy route discovery world (#12485)
• create-react-router - Fix missing fs-extra dependency (#12556)
• @react-router/dev/@react-router/serve - Properly initialize NODE_ENV if not already set for compatibility with React 19 (#12578)
• @react-router/dev - Remove the leftover/unused abortDelay prop from ServerRouter and update the default entry.server.tsx to use the new streamTimeout value for Single Fetch (#12478)
  • The abortDelay functionality was removed in v7 as it was coupled to the defer implementation from Remix v2, but this removal of this prop was missed
  • If you were still using this prop in your entry.server file, it's likely your app is not aborting streams as you would expect and you will need to adopt the new streamTimeout value introduced with Single Fetch
• @react-router/fs-routes - Throw error in flatRoutes if routes directory is missing (#12407)

Changes by Package

• create-react-router
• react-router
• @react-router/architect
• @react-router/cloudflare
• @react-router/dev
• @react-router/express
• @react-router/fs-routes
• @react-router/node
• @react-router/remix-config-routes-adapter
• @react-router/serve

Full Changelog: v7.0.2...v7.1.0

Date: 2024-12-02

Patch Changes

• react-router - Temporarily only use one build in export map so packages can have a peer dependency on react router (#12437)
• @react-router/dev - Support moduleResolution Node16 and NodeNext (#12440)
• @react-router/dev - Generate wide matches and params types for child routes (#12397)
  • At runtime, matches includes child route matches and params include child route path parameters
  • But previously, we only generated types for parent routes and the current route in matches and params
  • To align our generated types more closely to the runtime behavior, we now generate more permissive, wider types when accessing child route information

Full Changelog: v7.0.1...v7.0.2

Date: 2024-11-22

Patch Changes

• @react-router/dev - Ensure typegen file watcher is cleaned up when Vite dev server restarts (#12331)
• @react-router/dev - Pass route error to ErrorBoundary as a prop (#12338)

Full Changelog: v7.0.0...v7.0.1

Date: 2024-11-21

Breaking Changes

Package Restructuring

• The react-router-dom, @remix-run/react, @remix-run/server-runtime, and @remix-run/router have been collapsed into the react-router package
  • To ease migration, react-router-dom is still published in v7 as a re-export of everything from react-router
• The @remix-run/cloudflare-pages and @remix-run/cloudflare-workers have been collapsed into @react-router/cloudflare package`
• The react-router-dom-v5-compat and react-router-native packages are removed starting with v7

Removed Adapter Re-exports

Remix v2 used to re-export all common @remix-run/server-runtime APIs through the various runtime packages (node, cloudflare, deno) so that you wouldn't need an additional @remix-run/server-runtime dependency in your package.json. With the collapsing of packages into react-router, these common APIs are now no longer re-exported through the runtime adapters. You should import all common APIs from react-router, and only import runtime-specific APIs from the runtime packages:

// Runtime-specific APIs
import { createFileSessionStorage } from "@react-router/node";
// Runtime-agnostic APIs
import { redirect, useLoaderData } from "react-router";

Removed APIs

The following APIs have been removed in React Router v7:

• json
• defer
• unstable_composeUploadHandlers
• unstable_createMemoryUploadHandler
• unstable_parseMultipartFormData

Minimum Versions

React Router v7 requires the following minimum versions:

• node@20
  • React Router no longer provides an installGlobals method to polyfill the fetch API
• react@18, react-dom@18

Adopted Future Flag Behaviors

Remix and React Router follow an API Development Strategy leveraging "Future Flags" to avoid introducing a slew of breaking changes in a major release. Instead, breaking changes are introduced in minor releases behind a flag, allowing users to opt-in at their convenience. In the next major release, all future flag behaviors become the default behavior.

The following previously flagged behaviors are now the default in React Router v7:

• React Router v6 flags
  • future.v7_relativeSplatPath
  • future.v7_startTransition
  • future.v7_fetcherPersist
  • future.v7_normalizeFormMethod
  • future.v7_partialHydration
  • future.v7_skipActionStatusRevalidation
• Remix v2 flags
  • future.v3_fetcherPersist
  • future.v3_relativeSplatPath
  • future.v3_throwAbortReason
  • future.v3_singleFetch
  • future.v3_lazyRouteDiscovery
  • future.v3_optimizeDeps

Vite Compiler

The Remix Vite plugin is the proper way to build full-stack SSR apps using React Router v7. The former esbuild-based compiler is no longer available.

Renamed vitePlugin and cloudflareDevProxyVitePlugin

For Remix consumers migrating to React Router, the vitePlugin and cloudflareDevProxyVitePlugin exports have been renamed and moved (#11904)

-import {
-  vitePlugin as remix,
-  cloudflareDevProxyVitePlugin,
-} from "@remix/dev";

+import { reactRouter } from "@react-router/dev/vite";
+import { cloudflareDevProxy } from "@react-router/dev/vite/cloudflare";

Removed manifest option

For Remix consumers migrating to React Router, the Vite plugin's manifest option has been removed. The manifest option been superseded by the more powerful buildEnd hook since it's passed the buildManifest argument. You can still write the build manifest to disk if needed, but you'll most likely find it more convenient to write any logic depending on the build manifest within the buildEnd hook itself. (#11573)

If you were using the manifest option, you can replace it with a buildEnd hook that writes the manifest to disk like this:

// react-router.config.ts
import { type Config } from "@react-router/dev/config";
import { writeFile } from "node:fs/promises";

export default {
  async buildEnd({ buildManifest }) {
    await writeFile(
      "build/manifest.json",
      JSON.stringify(buildManifest, null, 2),
      "utf-8"
    );
  },
} satisfies Config;

Exposed Router Promises

Because React 19 will have first-class support for handling promises in the render pass (via React.use and useAction), we are now comfortable exposing the promises for the APIs that previously returned undefined:

• useNavigate()
• useSubmit()
• useFetcher().load
• useFetcher().submit
• useRevalidator().revalidate()

Other Notable Changes

routes.ts

When using the React Router Vite plugin, routes are defined in app/routes.ts. Route config is exported via the routes export, conforming to the RouteConfig type. Route helper functions route, index, and layout are provided to make declarative type-safe route definitions easier.

// app/routes.ts
import {
  type RouteConfig,
  route,
  index,
  layout,
} from "@react-router/dev/routes";

export const routes: RouteConfig = [
  index("./home.tsx"),
  route("about", "./about.tsx"),

  layout("./auth/layout.tsx", [
    route("login", "./auth/login.tsx"),
    route("register", "./auth/register.tsx"),
  ]),

  route("concerts", [
    index("./concerts/home.tsx"),
    route(":city", "./concerts/city.tsx"),
    route("trending", "./concerts/trending.tsx"),
  ]),
];

For Remix consumers migrating to React Router, you can still configure file system routing within routes.ts using the @react-router/fs-routes package. A minimal route config that reproduces the default Remix setup looks like this:

// app/routes.ts
import { type RouteConfig } from "@react-router/dev/routes";
import { flatRoutes } from "@react-router/fs-routes";

export const routes: RouteConfig = flatRoutes();

If you want to migrate from file system routing to config-based routes, you can mix and match approaches by spreading the results of the async flatRoutes function into the array of config-based routes.

// app/routes.ts
import { type RouteConfig, route } from "@react-router/dev/routes";
import { flatRoutes } from "@react-router/fs-routes";

export const routes: RouteConfig = [
  // Example config-based route:
  route("/hello", "./routes/hello.tsx"),

  // File system routes scoped to a different directory:
  ...(await flatRoutes({
    rootDirectory: "fs-routes",
  })),
];

If you were using Remix's routes option to use alternative file system routing conventions, you can adapt these to the new RouteConfig format using @react-router/remix-config-routes-adapter.

For example, if you were using Remix v1 route conventions in Remix v2, you can combine @react-router/remix-config-routes-adapter with @remix-run/v1-route-convention to adapt this to React Router:

// app/routes.ts
import { type RouteConfig } from "@react-router/dev/routes";
import { remixConfigRoutes } from "@react-router/remix-config-routes-adapter";
import { createRoutesFromFolders } from "@remix-run/v1-route-convention";

export const routes: RouteConfig = remixConfigRoutes(async (defineRoutes) => {
  return createRoutesFromFolders(defineRoutes, {
    ignoredFilePatterns: ["**/.*", "**/*.css"],
  });
});

Also note that, if you were using Remix's routes option to define config-based routes, you can also adapt these to the new RouteConfig format using @react-router/remix-config-routes-adapter with minimal code changes. While this makes for a fast migration path, we recommend migrating any config-based routes from Remix to the new RouteConfig format since it's a fairly straightforward migration.

// app/routes.ts
-import { type RouteConfig } from "@react-router/dev/routes";
+import { type RouteConfig, route } from "@react-router/dev/routes";
-import { remixConfigRoutes } from "@react-router/remix-config-routes-adapter";

-export const routes: RouteConfig = remixConfigRoutes(async (defineRoutes) => {
-  defineRoutes((route) => {
-    route("/parent", "./routes/parent.tsx", () => [
-      route("/child", "./routes/child.tsx"),
-    ]);
-  });
-});
+export const routes: RouteConfig = [
+  route("/parent", "./routes/parent.tsx", [
+    route("/child", "./routes/child.tsx"),
+  ]),
+];

Type-safety improvements

React Router now generates types for each of your route modules and passes typed props to route module component exports (#11961, #12019). You can access those types by importing them from ./+types/<route filename without extension>.

See How To > Route Module Type Safety and Explanations > Type Safety for more details.

Prerendering

React Router v7 includes a new prerender config in the vite plugin to support SSG use-cases. This will pre-render your .html and .data files at build time and so you can serve them statically at runtime from a running server or a CDN (#11539)

export default defineConfig({
  plugins: [
    reactRouter({
      async prerender({ getStaticPaths }) {
        let slugs = await fakeGetSlugsFromCms();
        return [
          ...getStaticPaths(),
          ...slugs.map((slug) => `/product/${slug}`),
        ];
      },
    }),
    tsconfigPaths(),
  ],
});

async function fakeGetSlugsFromCms() {
  await new Promise((r) => setTimeout(r, 1000));
  return ["shirt", "hat"];
}

Major Changes (react-router)

• Remove the original defer implementation in favor of using raw promises via single fetch and turbo-stream (#11744)
  • This removes these exports from React Router:
    • defer
    • AbortedDeferredError
    • type TypedDeferredData
    • UNSAFE_DeferredData
    • UNSAFE_DEFERRED_SYMBOL
• Collapse packages into react-router(#11505)
  • @remix-run/router
  • react-router-dom
  • @remix-run/server-runtime
  • @remix-run/testing
  • As a note, the react-router-dom package is maintained to ease adoption but it simply re-exports all APIs from react-router
• Drop support for Node 16, React Router SSR now requires Node 18 or higher (#11391, #11690)
• Remove future.v7_startTransition flag (#11696)
• Expose the underlying router promises from the following APIs for composition in React 19 APIs: (#11521)
• Remove future.v7_normalizeFormMethod future flag (#11697)
• Imports/Exports cleanup (#11840)
  • Removed the following exports that were previously public API from @remix-run/router
    • types
      • AgnosticDataIndexRouteObject
      • AgnosticDataNonIndexRouteObject
      • AgnosticDataRouteMatch
      • AgnosticDataRouteObject
      • AgnosticIndexRouteObject
      • AgnosticNonIndexRouteObject
      • AgnosticRouteMatch
      • AgnosticRouteObject
      • TrackedPromise
      • unstable_AgnosticPatchRoutesOnMissFunction
      • Action -> exported as NavigationType via react-router
      • Router exported as RemixRouter to differentiate from RR's <Router>
    • API
      • getToPathname (@private)
      • joinPaths (@private)
      • normalizePathname (@private)
      • resolveTo (@private)
      • stripBasename (@private)
      • createBrowserHistory -> in favor of createBrowserRouter
      • createHashHistory -> in favor of createHashRouter
      • createMemoryHistory -> in favor of createMemoryRouter
      • createRouter
      • createStaticHandler -> in favor of wrapper createStaticHandler in RR Dom
      • getStaticContextFromError
  • Removed the following exports that were previously public API from react-router
    • Hash
    • Pathname
    • Search
• Remove future.v7_prependBasename from the internalized @remix-run/router package (#11726)
• Remove future.v7_throwAbortReason from internalized @remix-run/router package (#11728)
• Add exports field to all packages (#11675)
• Renamed RemixContext to FrameworkContext (#11705)
• Update the minimum React version to 18 (#11689)
• PrefetchPageDescriptor replaced by PageLinkDescriptor (#11960)
• Remove the future.v7_partialHydration flag (#11725)
  • This also removes the <RouterProvider fallbackElement> prop
    • To migrate, move the fallbackElement to a hydrateFallbackElement/HydrateFallback on your root route
  • Also worth nothing there is a related breaking changer with this future flag:
    • Without future.v7_partialHydration (when using fallbackElement), state.navigation was populated during the initial load
    • With future.v7_partialHydration, state.navigation remains in an "idle" state during the initial load
• Remove future.v7_relativeSplatPath future flag (#11695)
• Remove remaining future flags (#11820)
  • React Router v7_skipActionErrorRevalidation
  • Remix v3_fetcherPersist, v3_relativeSplatPath, v3_throwAbortReason
• Rename createRemixStub to createRoutesStub (#11692)
• Remove @remix-run/router deprecated detectErrorBoundary option in favor of mapRouteProperties (#11751)
• Add react-router/dom subpath export to properly enable react-dom as an optional peerDependency (#11851)
  • This ensures that we don't blindly import ReactDOM from "react-dom" in <RouterProvider> in order to access ReactDOM.flushSync(), since that would break createMemoryRouter use cases in non-DOM environments
  • DOM environments should import from react-router/dom to get the proper component that makes ReactDOM.flushSync() available:
    • If you are using the Vite plugin, use this in your entry.client.tsx:
      • import { HydratedRouter } from 'react-router/dom'
    • If you are not using the Vite plugin and are manually calling createBrowserRouter/createHashRouter:
      • import { RouterProvider } from "react-router/dom"
• Remove future.v7_fetcherPersist flag (#11731)
• Allow returning undefined from loaders and actions (#11680, #12057)
• Use createRemixRouter/RouterProvider in entry.client instead of RemixBrowser (#11469)
• Remove the deprecated json utility (#12146)
  • You can use Response.json if you still need to construct JSON responses in your app

Major Changes (@react-router/*)

• Remove future.v3_singleFetch flag (#11522)
• Drop support for Node 16 and 18, update minimum Node version to 20 (#11690, #12171)
  • Remove installGlobals() as this should no longer be necessary
• Add exports field to all packages (#11675)
• No longer re-export APIs from react-router through different runtime/adapter packages (#11702)
• For Remix consumers migrating to React Router, the crypto global from the Web Crypto API is now required when using cookie and session APIs
  • This means that the following APIs are provided from react-router rather than platform-specific packages: (#11837)
    • createCookie
    • createCookieSessionStorage
    • createMemorySessionStorage
    • createSessionStorage
  • For consumers running older versions of Node, the installGlobals function from @remix-run/node has been updated to define globalThis.crypto, using Node's require('node:crypto').webcrypto implementation
  • Since platform-specific packages no longer need to implement this API, the following low-level APIs have been removed:
    • createCookieFactory
    • createSessionStorageFactory
    • createCookieSessionStorageFactory
    • createMemorySessionStorageFactory
• Consolidate types previously duplicated across @remix-run/router, @remix-run/server-runtime, and @remix-run/react now that they all live in react-router (#12177)
  • Examples: LoaderFunction, LoaderFunctionArgs, ActionFunction, ActionFunctionArgs, DataFunctionArgs, RouteManifest, LinksFunction, Route, EntryRoute
  • The RouteManifest type used by the "remix" code is now slightly stricter because it is using the former @remix-run/router RouteManifest
    • Record<string, Route> -> Record<string, Route | undefined>
  • Removed AppData type in favor of inlining unknown in the few locations it was used
  • Removed ServerRuntimeMeta* types in favor of the Meta* types they were duplicated from
• Migrate Remix v2 type generics to React Router (#12180)
  • These generics are provided for Remix v2 migration purposes
  • These generics and the APIs they exist on should be considered informally deprecated in favor of the new Route.* types
  • Anyone migrating from React Router v6 should probably not leverage these new generics and should migrate straight to the Route.* types
  • For React Router v6 users, these generics are new and should not impact your app, with one exception
    • useFetcher previously had an optional generic (used primarily by Remix v2) that expected the data type
    • This has been updated in v7 to expect the type of the function that generates the data (i.e., typeof loader/typeof action)
    • Therefore, you should update your usages:
      • ❌ useFetcher<LoaderData>()
      • ✅ useFetcher<typeof loader>()
• Update cookie dependency to ^1.0.1 - please see the release notes for any breaking changes (#12172)
• @react-router/cloudflare - For Remix consumers migrating to React Router, all exports from @remix-run/cloudflare-pages are now provided for React Router consumers in the @react-router/cloudflare package. There is no longer a separate package for Cloudflare Pages. (#11801)
• @react-router/cloudflare - The @remix-run/cloudflare-workers package has been deprecated. Remix consumers migrating to React Router should use the @react-router/cloudflare package directly. For guidance on how to use @react-router/cloudflare within a Cloudflare Workers context, refer to the Cloudflare Workers template. (#11801)
• @react-router/dev - For Remix consumers migrating to React Router, the vitePlugin and cloudflareDevProxyVitePlugin exports have been renamed and moved. (#11904)
• @react-router/dev - For Remix consumers migrating to React Router who used the Vite plugin's buildEnd hook, the resolved reactRouterConfig object no longer contains a publicPath property since this belongs to Vite, not React Router (#11575)
• @react-router/dev - For Remix consumers migrating to React Router, the Vite plugin's manifest option has been removed (#11573)
• @react-router/dev - Update default isbot version to v5 and drop support for isbot@3 (#11770)
  • If you have isbot@4 or isbot@5 in your package.json:
    • You do not need to make any changes
  • If you have isbot@3 in your package.json and you have your own entry.server.tsx file in your repo
    • You do not need to make any changes
    • You can upgrade to isbot@5 independent of the React Router v7 upgrade
  • If you have isbot@3 in your package.json and you do not have your own entry.server.tsx file in your repo
    • You are using the internal default entry provided by React Router v7 and you will need to upgrade to isbot@5 in your package.json
• @react-router/dev - For Remix consumers migrating to React Router, Vite manifests (i.e. .vite/manifest.json) are now written within each build subdirectory, e.g. build/client/.vite/manifest.json and build/server/.vite/manifest.json instead of build/.vite/client-manifest.json and build/.vite/server-manifest.json. This means that the build output is now much closer to what you'd expect from a typical Vite project. (#11573)
  • Originally the Remix Vite plugin moved all Vite manifests to a root-level build/.vite directory to avoid accidentally serving them in production, particularly from the client build. This was later improved with additional logic that deleted these Vite manifest files at the end of the build process unless Vite's build.manifest had been enabled within the app's Vite config. This greatly reduced the risk of accidentally serving the Vite manifests in production since they're only present when explicitly asked for. As a result, we can now assume that consumers will know that they need to manage these additional files themselves, and React Router can safely generate a more standard Vite build output.

Minor Changes

• react-router - Params, loader data, and action data as props for route component exports (#11961)
• react-router - Add route module type generation (#12019)
• react-router - Remove duplicate RouterProvider implementations (#11679)
• react-router - Stabilize unstable_dataStrategy (#11969)
• react-router - Stabilize unstable_patchRoutesOnNavigation (#11970)
• react-router - Add prefetching support to Link/NavLink when using Remix SSR (#11402)
• react-router - Enhance ScrollRestoration so it can restore properly on an SSR'd document load (#11401)
• @react-router/dev - Add support for the prerender config in the React Router vite plugin, to support existing SSG use-cases (#11539)
• @react-router/dev - Remove internal entry.server.spa.tsx implementation which was not compatible with the Single Fetch async hydration approach (#11681)
• @react-router/serve: Update express.static configurations to support new prerender API (#11547)
  • Assets in the build/client/assets folder are served as before, with a 1-year immutable Cache-Control header
  • Static files outside of assets, such as pre-rendered .html and .data files are not served with a specific Cache-Control header
  • .data files are served with Content-Type: text/x-turbo
    • For some reason, when adding this via express.static, it seems to also add a Cache-Control: public, max-age=0 to .data files

Patch Changes

• Replace substr with substring (#12080)
• react-router - Fix redirects returned from loaders/actions using data() (#12021)
• @react-router/dev - Enable prerendering for resource routes (#12200)
• @react-router/dev - resolve config directory relative to flat output file structure (#12187)

Changes by Package

• react-router
• @react-router/architect
• @react-router/cloudflare
• @react-router/dev
• @react-router/express
• @react-router/fs-routes
• @react-router/node
• @react-router/remix-config-routes-adapter
• @react-router/serve

Full Changelog: v6.28.0...v7.0.0