Ask your question and get a summary of the document by referencing this page and the AI provider of your choice
Version History
- "Add usePathname utility"v10.0.023/06/2026
- "Init history"v8.2.022/06/2026
The content of this page was translated using an AI.
See the last version of the original content in EnglishIf you have an idea for improving this documentation, please feel free to contribute by submitting a pull request on GitHub.
GitHub link to the documentationCopy doc Markdown to clipboard
Preact Integration: usePathname Hook Documentation
The usePathname hook returns the current browser pathname with the locale segment stripped. It is useful for building locale-aware navigation — for example, determining which nav item is active — without having to manually remove the locale prefix.
Importing usePathname in Preact
Copy the code to the clipboard
import { usePathname } from "preact-intlayer";Overview
usePathname reads window.location.pathname, strips the locale prefix via getPathWithoutLocale, and re-renders the component whenever the browser fires a popstate event (back/forward navigation). It returns an empty string during server-side rendering.
Usage
Copy the code to the clipboard
import type { FunctionComponent } from "preact";import { usePathname } from "preact-intlayer";type NavItemProps = { href: string; label: string;};const NavItem: FunctionComponent<NavItemProps> = ({ href, label }) => { const pathname = usePathname(); const isActive = pathname === href; return ( <a href={href} aria-current={isActive ? "page" : undefined}> {label} </a> );};export default NavItem;Return Value
Open the table in a modal to view all data content clearly
| Type | Description |
|---|---|
string | The current pathname without the locale prefix. Empty string during server-side rendering. |
Behaviour
- Locale stripping: Removes the leading locale segment (e.g.
/en-GB/dashboard→/dashboard). - Reactive: Updates automatically on
popstateevents (browser back / forward navigation). - SSR-safe: Returns
""whenwindowis not available. - Cleanup: The
popstatelistener is removed automatically when the component unmounts.
Example
Copy the code to the clipboard
import type { FunctionComponent } from "preact";import { usePathname } from "preact-intlayer";const links = [ { href: "/dashboard", label: "Dashboard" }, { href: "/settings", label: "Settings" },];const Sidebar: FunctionComponent = () => { const pathname = usePathname(); return ( <nav> {links.map(({ href, label }) => ( <a key={href} href={href} style={{ fontWeight: pathname === href ? "bold" : "normal" }} > {label} </a> ))} </nav> );};export default Sidebar;Related
useLocale— current locale + locale switchergetPathWithoutLocale— the underlying utility used by this hook