Back to React Router

useMatches

docs/api/hooks/useMatches.md

7.6.2898 B
Original Source

useMatches

<!-- ⚠️ ⚠️ IMPORTANT ⚠️ ⚠️ Thank you for helping improve our documentation! This file is auto-generated from the JSDoc comments in the source code, so please edit the JSDoc comments in the file below and this file will be re-generated once those changes are merged. https://github.com/remix-run/react-router/blob/main/packages/react-router/lib/hooks.tsx -->

[MODES: framework, data]

Summary

Reference Documentation ↗

Returns the active route matches, useful for accessing loaderData for parent/child routes or the route handle property

Signature

tsx
function useMatches(): UIMatch[]

Returns

An array of UI matches for the current route hierarchy