| --- |
| title: usePathname |
| description: API Reference for the usePathname hook. |
| --- |
|
|
| `usePathname` is a **Client Component** hook that lets you read the current URL's **pathname**. |
|
|
| ```tsx filename="app/example-client-component.tsx" switcher |
| 'use client' |
|
|
| import { usePathname } from 'next/navigation' |
|
|
| export default function ExampleClientComponent() { |
| const pathname = usePathname() |
| return <p>Current pathname: {pathname}</p> |
| } |
| ``` |
|
|
| ```jsx filename="app/example-client-component.js" switcher |
| 'use client' |
|
|
| import { usePathname } from 'next/navigation' |
|
|
| export default function ExampleClientComponent() { |
| const pathname = usePathname() |
| return <p>Current pathname: {pathname}</p> |
| } |
| ``` |
|
|
| `usePathname` intentionally requires using a [Client Component](/docs/app/getting-started/server-and-client-components). It's important to note Client Components are not a de-optimization. They are an integral part of the [Server Components](/docs/app/getting-started/server-and-client-components) architecture. |
|
|
| For example, a Client Component with `usePathname` will be rendered into HTML on the initial page load. When navigating to a new route, this component does not need to be re-fetched. Instead, the component is downloaded once (in the client JavaScript bundle), and re-renders based on the current state. |
|
|
| > **Good to know**: |
| > |
| > - Reading the current URL from a [Server Component](/docs/app/getting-started/server-and-client-components) is not supported. This design is intentional to support layout state being preserved across page navigations. |
| > - Compatibility mode: |
| > - `usePathname` can return `null` when a [fallback route](/docs/pages/api-reference/functions/get-static-paths |
| > - When using `usePathname` with rewrites in [`next.config`](/docs/app/api-reference/config/next-config-js/rewrites) or [`Middleware`](/docs/app/api-reference/file-conventions/middleware), `useState` and `useEffect` must also be used in order to avoid hydration mismatch errors. |
| > - Next.js will automatically update your types if it detects both an `app` and `pages` directory in your project. |
|
|
| |
|
|
| ```tsx |
| const pathname = usePathname() |
| ``` |
|
|
| `usePathname` does not take any parameters. |
|
|
| |
|
|
| `usePathname` returns a string of the current URL's pathname. For example: |
|
|
| | URL | Returned value | |
| | ------------------- | --------------------- | |
| | `/` | `'/'` | |
| | `/dashboard` | `'/dashboard'` | |
| | `/dashboard?v=2` | `'/dashboard'` | |
| | `/blog/hello-world` | `'/blog/hello-world'` | |
|
|
| |
|
|
| |
|
|
| ```tsx filename="app/example-client-component.tsx" switcher |
| 'use client' |
|
|
| import { usePathname, useSearchParams } from 'next/navigation' |
|
|
| function ExampleClientComponent() { |
| const pathname = usePathname() |
| const searchParams = useSearchParams() |
| useEffect(() => { |
| // Do something here... |
| }, [pathname, searchParams]) |
| } |
| ``` |
|
|
| ```jsx filename="app/example-client-component.js" switcher |
| 'use client' |
|
|
| import { usePathname, useSearchParams } from 'next/navigation' |
|
|
| function ExampleClientComponent() { |
| const pathname = usePathname() |
| const searchParams = useSearchParams() |
| useEffect(() => { |
| // Do something here... |
| }, [pathname, searchParams]) |
| } |
| ``` |
|
|
| | Version | Changes | |
| | --------- | ------------------------- | |
| | `v13.0.0` | `usePathname` introduced. | |
|
|
