main
Branches
main (6.4.1)dev
Versions
6.4.1v4/5.xv3.x
Picking a Router

Picking a Router

While your app will only use a single router, several routers are available depending on the environment you're app is running in. This document should help you figure out which one to use.

Using v6.4 Data APIs

In v6.4, new routers were introduced that support the new data APIs:

The following routers do not support the data APIs:

We recommend updating your app to use one of the new routers from 6.4. The data APIs are currently not supported in React Native, but should be eventually.

The easiest way to quickly update to a v6.4 is to get the help from createRoutesFromElements so you don't need to convert your <Route> elements to route objects.

import {
  createBrowserRouter,
  RouterProvider,
} from "react-router-dom";

const router = createBrowserRouter(
  createRoutesFromElements(
    <Route path="/" element={<Root />}>
      <Route path="dashboard" element={<Dashboard />} />
      {/* ... etc. */}
    </Route>
  )
);

ReactDOM.createRoot(document.getElementById("root")).render(
  <React.StrictMode>
    <RouterProvider router={router} />
  </React.StrictMode>
);

Web Projects

We recommend all web projects use createBrowserRouter.

It uses the full URL instead of the hash urls (#this/stuff) common in web apps before window.pushState was standardized. Full URLs are better for SEO, better for server rendering, and are just more compatible with the rest of the web platform.

If you're hosting your app on a static file server, you'll need to configure it to send all requests to your index.html to avoid getting 404s.

If for some reason you can't use the full URL, createHashRouter is the next best thing.

If you're not interested in the data APIs, you can continue to use <BrowserRouter> or, if you can't use full URLs, <HashRouter>.

Testing

Testing components that use React Router APIs is easiest with createMemoryRouter or <MemoryRouter> instead of the routers you use in your app that require DOM history APIs.

React Native

You will use <NativeRouter> from React Native projects.

The data APIs from v6.4 are currently not supported in React Native, but should be eventually.

Docs and examples CC 4.0
Edit