Hook

useIsPathnameActive

Checks whether a pathname matches the current URL path, including nested routes.

Hook

import { useIsPathnameActive } from "@swirski/ui";

Live render

Preview

Active route helper

const active = useIsPathnameActive(
  "/components",
  "/components/button",
);

3 documented

Prop	Type	Default	Notes
`pathname`Required	`string \| URL`	`-`	Target pathname or URL to match.
`currentUrl`Required	`string \| URL`	`-`	Current route URL or pathname.
`options.exact`	`boolean`	`false`	Require an exact pathname match.

1 documented

Value	Type	Notes
`active`	`boolean`	True when currentUrl matches pathname or a nested child path.