react-router 7.15.1 → 8.3.0

package/docs/upgrading/component-routes.md

@@ -0,0 +1,363 @@
+---
+title: Framework Adoption from Component Routes
+order: 4
+---
+
+# Framework Adoption from Component Routes
+
+If you are using `<RouterProvider>` please see [Framework Adoption from RouterProvider][upgrade-router-provider] instead.
+
+If you are using `<Routes>` this is the right place.
+
+The React Router Vite plugin adds framework features to React Router. This guide will help you adopt the plugin in your app. If you run into any issues, please reach out for help on [Twitter](https://x.com/remix_run) or [Discord](https://remix.run/discord).
+
+## Features
+
+The Vite plugin adds:
+
+- Route loaders, actions, and automatic data revalidation
+- Type-safe Routes Modules
+- Automatic route code-splitting
+- Automatic scroll restoration across navigations
+- Optional Static pre-rendering
+- Optional Server rendering
+
+The initial setup requires the most work. However, once complete, you can adopt new features incrementally, one route at a time.
+
+## Prerequisites
+
+To use the Vite plugin, your project requires:
+
+- Node.js 22.22.0+
+- Vite 7+ or Vite 8+
+
+## 1. Install the Vite plugin
+
+**👉 Install the React Router Vite plugin**
+
+```shellscript nonumber
+npm install -D @react-router/dev
+```
+
+**👉 Install a runtime adapter**
+
+We will assume you are using Node as your runtime.
+
+```shellscript nonumber
+npm install @react-router/node
+```
+
+**👉 Swap out the React plugin for React Router.**
+
+```tsx diff filename=vite.config.ts
+-import react from '@vitejs/plugin-react'
++import { reactRouter } from "@react-router/dev/vite";
+import { defineConfig } from "vite";
+
+
+export default defineConfig({
+  plugins: [
+-    react()
++    reactRouter()
+  ],
+});
+```
+
+## 2. Add the React Router config
+
+**👉 Create a `react-router.config.ts` file**
+
+Add the following to the root of your project. In this config you can tell React Router about your project, like where to find the app directory and to not use SSR (server-side rendering) for now.
+
+```shellscript nonumber
+touch react-router.config.ts
+```
+
+```ts filename=react-router.config.ts
+import type { Config } from "@react-router/dev/config";
+
+export default {
+  appDirectory: "src",
+  ssr: false,
+} satisfies Config;
+```
+
+## 3. Add the Root entry point
+
+In a typical Vite app, the `index.html` file is the entry point for bundling. The React Router Vite plugin moves the entry point to a `root.tsx` file so you can use React to render the shell of your app instead of static HTML, and eventually upgrade to Server Rendering if you want.
+
+**👉 Move your existing `index.html` to `root.tsx`**
+
+For example, if your current `index.html` looks like this:
+
+```html filename=index.html
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <meta
+      name="viewport"
+      content="width=device-width, initial-scale=1.0"
+    />
+    <title>My App</title>
+  </head>
+  <body>
+    <div id="root"></div>
+    <script type="module" src="/src/main.tsx"></script>
+  </body>
+</html>
+```
+
+You would move that markup into `src/root.tsx` and delete `index.html`:
+
+```shellscript nonumber
+touch src/root.tsx
+```
+
+```tsx filename=src/root.tsx
+import {
+  Links,
+  Meta,
+  Outlet,
+  Scripts,
+  ScrollRestoration,
+} from "react-router";
+
+export function Layout({
+  children,
+}: {
+  children: React.ReactNode;
+}) {
+  return (
+    <html lang="en">
+      <head>
+        <meta charSet="UTF-8" />
+        <meta
+          name="viewport"
+          content="width=device-width, initial-scale=1.0"
+        />
+        <title>My App</title>
+        <Meta />
+        <Links />
+      </head>
+      <body>
+        {children}
+        <ScrollRestoration />
+        <Scripts />
+      </body>
+    </html>
+  );
+}
+
+export default function Root() {
+  return <Outlet />;
+}
+```
+
+## 4. Add client entry module
+
+In the typical Vite app the `index.html` file points to `src/main.tsx` as the client entry point. React Router uses a file named `src/entry.client.tsx` instead.
+
+**👉 Make `src/entry.client.tsx` your entry point**
+
+If your current `src/main.tsx` looks like this:
+
+```tsx filename=src/main.tsx
+import React from "react";
+import ReactDOM from "react-dom/client";
+import { BrowserRouter } from "react-router";
+import "./index.css";
+import App from "./App";
+
+ReactDOM.createRoot(
+  document.getElementById("root")!,
+).render(
+  <React.StrictMode>
+    <BrowserRouter>
+      <App />
+    </BrowserRouter>
+  </React.StrictMode>,
+);
+```
+
+You would rename it to `entry.client.tsx` and change it to this:
+
+```tsx filename=src/entry.client.tsx
+import React from "react";
+import ReactDOM from "react-dom/client";
+import { HydratedRouter } from "react-router/dom";
+import "./index.css";
+
+ReactDOM.hydrateRoot(
+  document,
+  <React.StrictMode>
+    <HydratedRouter />
+  </React.StrictMode>,
+);
+```
+
+- Use `hydrateRoot` instead of `createRoot`
+- Render a `<HydratedRouter>` instead of your `<App/>` component
+- Note: we stopped rendering the `<App/>` component. We'll bring it back in a later step, but first we want to get the app to boot with the new entry point.
+
+## 5. Shuffle stuff around
+
+Between `root.tsx` and `entry.client.tsx`, you may want to shuffle some stuff around between them.
+
+In general:
+
+- `root.tsx` contains any rendering things like context providers, layouts, styles, etc.
+- `entry.client.tsx` should be as minimal as possible
+- Remember to _not_ try to render your existing `<App/>` component yet, we'll do that in a later step
+
+Note that your `root.tsx` file will be statically generated and served as the entry point of your app, so just that module will need to be compatible with server rendering. This is where most of your trouble will come.
+
+## 6. Set up your routes
+
+The React Router Vite plugin uses a `routes.ts` file to configure your routes. For now we'll add a simple catchall route to get things going.
+
+**👉 Set up a `catchall.tsx` route**
+
+```shellscript nonumber
+touch src/routes.ts src/catchall.tsx
+```
+
+```ts filename=src/routes.ts
+import {
+  type RouteConfig,
+  route,
+} from "@react-router/dev/routes";
+
+export default [
+  // * matches all URLs, the ? makes it optional so it will match / as well
+  route("*?", "catchall.tsx"),
+] satisfies RouteConfig;
+```
+
+**👉 Render a placeholder route**
+
+Eventually we'll replace this with our original `App` component, but for now we'll just render something simple to make sure we can boot the app.
+
+```tsx filename=src/catchall.tsx
+export default function Component() {
+  return <div>Hello, world!</div>;
+}
+```
+
+[View our guide on configuring routes][configuring-routes] to learn more about the `routes.ts` file.
+
+## 7. Boot the app
+
+At this point you should be able to boot the app and see the root layout.
+
+**👉 Add `dev` script and run the app**
+
+```json filename=package.json
+"scripts": {
+  "dev": "react-router dev"
+}
+```
+
+Now make sure you can boot your app at this point before moving on:
+
+```shellscript
+npm run dev
+```
+
+You will probably want to add `.react-router/` to your `.gitignore` file to avoid tracking unnecessary files in your repository.
+
+```txt
+.react-router/
+```
+
+You can check out [Type Safety][type-safety] to learn how to fully set up and use autogenerated type safety for params, loader data, and more.
+
+## 8. Render your app
+
+To get back to rendering your app, we'll update the "catchall" route we set up earlier that matches all URLs so that your existing `<Routes>` get a chance to render.
+
+**👉 Update the catchall route to render your app**
+
+```tsx filename=src/catchall.tsx
+import App from "./App";
+
+export default function Component() {
+  return <App />;
+}
+```
+
+Your app should be back on the screen and working as usual!
+
+## 9. Migrate a route to a Route Module
+
+You can now incrementally migrate your routes to route modules.
+
+Given an existing route like this:
+
+```tsx filename=src/App.tsx
+// ...
+import About from "./containers/About";
+
+export default function App() {
+  return (
+    <Routes>
+      <Route path="/about" element={<About />} />
+    </Routes>
+  );
+}
+```
+
+**👉 Add the route definition to `routes.ts`**
+
+```tsx filename=src/routes.ts
+import {
+  type RouteConfig,
+  route,
+} from "@react-router/dev/routes";
+
+export default [
+  route("/about", "./pages/about.tsx"),
+  route("*?", "catchall.tsx"),
+] satisfies RouteConfig;
+```
+
+**👉 Add the route module**
+
+Edit the route module to use the [Route Module API][route-modules]:
+
+```tsx filename=src/pages/about.tsx
+export async function clientLoader() {
+  // you can now fetch data here
+  return {
+    title: "About page",
+  };
+}
+
+export default function Component({ loaderData }) {
+  return <h1>{loaderData.title}</h1>;
+}
+```
+
+See [Type Safety][type-safety] to set up autogenerated type safety for params, loader data, and more.
+
+The first few routes you migrate are the hardest because you often have to access various abstractions a bit differently than before (like in a loader instead of from a hook or context). But once the trickiest bits get dealt with, you get into an incremental groove.
+
+## Enable SSR and/or Pre-rendering
+
+If you want to enable server rendering and static pre-rendering, you can do so with the `ssr` and `prerender` options in the bundler plugin. For SSR you'll need to also deploy the server build to a server.
+
+```ts filename=react-router.config.ts
+import type { Config } from "@react-router/dev/config";
+
+export default {
+  ssr: true,
+  async prerender() {
+    return ["/", "/about", "/contact"];
+  },
+} satisfies Config;
+```
+
+[upgrade-router-provider]: ./router-provider
+[configuring-routes]: ../start/framework/routing
+[route-modules]: ../start/framework/route-module
+[type-safety]: ../how-to/route-module-type-safety

package/docs/upgrading/future.md

@@ -0,0 +1,111 @@
+---
+title: Future Changes
+order: 1
+---
+
+# Future Changes
+
+We try our best to keep major version upgrades simple and boring through the use of opt-in APIs and [Future Flags][api-development-strategy]. Future flags are used to gate breaking changes that don't otherwise have a good call-site opt-in strategy. By adopting all opt-in APIs and future flags, you should be able to upgrade to the next major version of React Router with minimal changes.
+
+We plan to ship new major versions roughly once a year as described in our [Open Governance Model][governance], so this guide will continue to track future changes you can adopt ahead of the next major release. v9 is currently estimated for mid-2027 when Node 22 reaches EOL.
+
+We highly recommend you make a commit after each step and ship it instead of doing everything all at once. Most flags can be adopted in any order, with exceptions noted below.
+
+<docs-info>This is an evolving document that will be updated throughout the duration of v8</docs-info>
+
+## Minimum Versions
+
+[MODES: framework, data, declarative]
+
+<br/>
+<br/>
+
+React Router v9 will require the following minimum versions (as of now). You can prepare for the upgrade by updating them while still on v8:
+
+- `node@24+`
+
+## Update to latest v8.x
+
+Before adopting any future flags or call-site opt-in changes, you should update to the latest minor version of v8.x to make sure you have access to the latest flags. You may see a number of deprecation warnings as you upgrade, which we'll cover below.
+
+👉 Update to latest v8
+
+```sh
+npm install react-router@8 @react-router/{dev,node,etc.}@8
+```
+
+## Future Flags
+
+_No future flags yet_
+
+## Other Planned Breaking Changes
+
+_No known planned breaking changes yet_
+
+## Unstable Future Flags (Optional)
+
+We document some [unstable] flags here as a reference for folks contributing to the project via beta testing, but they are not generally recommended for production use and may have breaking changes in patch or minor releases - adopt with caution!
+
+### `future.unstable_enableNodeReadableStream`
+
+[MODES: framework]
+
+<br/>
+<br/>
+
+**Background**
+
+Now that the Web Streams API is [stable](https://nodejs.org/docs/latest-v22.x/api/webstreams.html) in Node 22+, it's viable for React Router to use React's [`renderToReadableStream`](https://react.dev/reference/react-dom/server/renderToReadableStream) in the server entry.
+
+When no `entry.server.tsx` file is present, React Router defaults to [`renderToPipeableStream`](https://react.dev/reference/react-dom/server/renderToPipeableStream) when a Node runtime is detected, and `renderToReadableStream` otherwise.
+
+With this flag enabled, React Router will default to `renderToReadableStream` on all runtimes, including Node. You can continue to use `renderToPipeableStream` via a custom `entry.server.tsx` file if needed.
+
+<docs-info>Enabling this flag might even provide slight performance gains because we are already using Web Streams internally, so this flag removes some unnecessary transforms between Web and Node streams.</docs-info>
+
+👉 **Enable the Flag**
+
+```ts filename=react-router.config.ts
+import type { Config } from "@react-router/dev/config";
+
+export default {
+  future: {
+    unstable_enableNodeReadableStream: true,
+  },
+} satisfies Config;
+```
+
+**Update your Code**
+
+No code changes are required. If your app has a custom `entry.server.tsx`, this flag will not change your runtime behavior.
+
+### `future.unstable_optimizeDeps`
+
+[MODES: framework]
+
+<br/>
+<br/>
+
+**Background**
+
+This flag lets React Router provide Vite's dependency optimizer with the client entry file and route module files. This can improve dependency optimization in development, but the behavior is still experimental.
+
+👉 **Enable the Flag**
+
+```ts filename=react-router.config.ts
+import type { Config } from "@react-router/dev/config";
+
+export default {
+  future: {
+    unstable_optimizeDeps: true,
+  },
+} satisfies Config;
+```
+
+**Update your Code**
+
+No code changes are required. If you run into dependency optimization issues after enabling this flag, remove the flag and restart the dev server.
+
+[api-development-strategy]: ../community/api-development-strategy
+[governance]: https://github.com/remix-run/react-router/blob/main/GOVERNANCE.md#design-goals
+[unstable]: ../community/api-development-strategy#unstable-flags

package/docs/upgrading/index.md

@@ -0,0 +1,4 @@
+---
+title: Upgrading
+order: 2
+---