RouterProvider

Data

Summary

Render the UI for the given DataRouter. This component should typically be at the top of an app's element tree. The router prop should be a single router instance created outside of the React tree. Avoid creating new routers during React renders/re-renders.

import { createBrowserRouter } from "react-router";
import { RouterProvider } from "react-router/dom";
import { createRoot } from "react-dom/client";

const router = createBrowserRouter(routes);
createRoot(document.getElementById("root")).render(
  <RouterProvider router={router} />
);

Info

Please note that this component is exported both from react-router and react-router/dom with the only difference being that the latter automatically wires up react-dom's flushSync implementation. You almost always want to use the version from react-router/dom unless you're running in a non-DOM environment.

Signature

function RouterProvider({
  router,
  flushSync: reactDomFlushSyncImpl,
  onError,
  useTransitions,
}: RouterProviderProps): React.ReactElement

Props

flushSync

The ReactDOM.flushSync implementation to use for flushing updates.

You usually don't have to worry about this:

The RouterProvider exported from react-router/dom handles this internally for you
If you are rendering in a non-DOM environment, you can import RouterProvider from react-router and ignore this prop

onError

An error handler function that will be called for any middleware, loader, action, or render errors that are encountered in your application. This is useful for logging or reporting errors instead of in the ErrorBoundary because it's not subject to re-rendering and will only run one time per error.

The errorInfo parameter is passed along from componentDidCatch and is only present for render errors.

<RouterProvider onError={(error, info) => {
  let { location, params, pattern, errorInfo } = info;
  console.error(error, location, errorInfo);
  reportToErrorService(error, location, errorInfo);
}} />

router

The DataRouter instance to use for navigation and data fetching. The router prop should be a single router instance created outside of the React tree. Avoid creating new routers during React renders/re-renders.

useTransitions

Control whether router state updates are internally wrapped in React.startTransition.

When left undefined, all state updates are wrapped in React.startTransition
- This can lead to buggy behaviors if you are wrapping your own navigations/fetchers in startTransition.
When set to true, Link and Form navigations will be wrapped in React.startTransition and router state changes will be wrapped in React.startTransition and also sent through useOptimistic to surface mid-navigation router state changes to the UI.
When set to false, the router will not leverage React.startTransition or React.useOptimistic on any navigations or state changes.

For more information, please see the docs.