main
Branches
main (6.4.1)dev
Versions
6.4.1v4/5.xv3.x
useRouteLoaderData

useRouteLoaderData

This hook makes the data at any currently rendered route available anywhere in the tree. This is useful for components deep in the tree needing data from routes much farther up, as well as parent routes needing the data of child routes deeper in the tree.

import { useRouteLoaderData } from "react-router-dom";

function SomeComp() {
  const user = useRouteLoaderData("root");
  // ...
}

React Router stores data internally with deterministic, auto-generated route ids, but you can supply your own route id to make this hook much easier to work with. Consider a router with a route that defines an id:

createBrowserRouter([
  {
    path: "/",
    loader: () => fetchUser(),
    element: <Root />,
    id: "root",
    children: [
      {
        path: "jobs/:jobId",
        loader: loadJob,
        element: <JobListing />,
      },
    ],
  },
]);

Now the user is available anywhere else in the app.

const user = useRouteLoaderData("root");

The only data available is the routes that are currently rendered. If you ask for data from a route that is not currently rendered, the hook will return undefined.

Docs and examples CC 4.0
Edit