usePathname

usePathname is a hook that returns the current URL's pathname as a string.

"use client";

import { usePathname } from "@react-just/router";

export default function ExampleClientComponent() {
  const pathname = usePathname();

  // URL -> /profile/settings
  // `pathname` -> '/profile/settings'
}

Parameters

const pathname = usePathname();

usePathname takes no parameters.

Returns

usePathname returns the current URL pathname as a string.

function usePathname(): string;

The hook must be used within a Router component. Otherwise, it throws an error.

Example

Route	URL	Returned value
/	/	"/"
/orders	/orders	"/orders"
/orders	/orders?id=2	"/orders"
/blog/:blogId	/blog/1	"/blog/1"