• Preparing search index...
  • The search index is not available
React Router API Reference
  • React Router API Reference
  • react-router
  • useMatch

Function useMatch

  • useMatch<ParamKey, Path>(pattern): PathMatch<ParamKey> | null
  • Returns a PathMatch object if the given pattern matches the current URL. This is useful for components that need to know "active" state, e.g. <NavLink>.

    Type Parameters

    • ParamKey extends string
    • Path extends string

    Parameters

    • pattern: Path | PathPattern<Path>

    Returns PathMatch<ParamKey> | null

    • Defined in packages/react-router/lib/hooks.tsx:160

Settings

Member Visibility
React Router API Reference
  • Loading...

Generated using TypeDoc