React Router v7 ドキュメント 日本語版

English

matchRoutes

概要

リファレンスドキュメント ↗

指定されたルートをロケーションにマッチさせ、マッチデータを返します。

import { matchRoutes } from "react-router";
 
let routes = [{
  path: "/",
  Component: Root,
  children: [{
    path: "dashboard",
    Component: Dashboard,
  }]
}];
 
matchRoutes(routes, "/dashboard"); // [rootMatch, dashboardMatch]

シグネチャ

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

パラメータ

routes

マッチ対象となるルートオブジェクトの配列。

locationArg

マッチ対象となるロケーション。文字列パスまたは部分的な Location オブジェクトのいずれかです。

basename

マッチング前にロケーションから削除するオプションのベースパス。デフォルトは / です。

戻り値

マッチしたルートの配列、またはマッチが見つからなかった場合は null。