--- title: Framework Adoption from Component Routes order: 4 --- # Framework Adoption from Component Routes If you are using `` please see [Framework Adoption from RouterProvider][upgrade-router-provider] instead. If you are using `` 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://rmx.as/discord). ## Features The Vite plugin adds: - Route loaders, actions, and automatic data revalidation - Typesafe 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 20+ (if using Node as your runtime) - Vite 5+ ## 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.** ```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 My App

``` 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 ( My App {children} ); } export default function Root() { return ; } ``` ## 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( ); ``` 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, ); ``` - Use `hydrateRoot` instead of `createRoot` - Render a `` instead of your `` component - Note: we stopped rendering the `` 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 `` 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

Hello, world!

; } ``` [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 `` 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 ; } ``` 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 ( } /> ); } ``` **👉 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

{loaderData.title}

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