matchRoutes

[MODES: framework, data, declarative]

Summary

Reference Documentation ↗

Matches the given routes to a location and returns the match data.

tsx

import { matchRoutes } from "react-router";

let routes = [{
  path: "/",
  Component: Root,
  children: [{
    path: "dashboard",
    Component: Dashboard,
  }]
}];

matchRoutes(routes, "/dashboard"); // [rootMatch, dashboardMatch]

Signature

tsx

function matchRoutes<
  RouteObjectType extends AgnosticRouteObject = AgnosticRouteObject,
>(
  routes: RouteObjectType[],
  locationArg: Partial<Location> | string,
  basename = "/",
): AgnosticRouteMatch<string, RouteObjectType>[] | null

Params

routes

The array of route objects to match against.

locationArg

The location to match against, either a string path or a partial Location object

basename

Optional base path to strip from the location before matching. Defaults to /.

Returns

An array of matched routes, or null if no matches were found.