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.06/23/2026
- "Init history"v8.2.06/22/2026
If 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
Vue Integration: usePathname Composable Documentation
The usePathname composable returns the current browser pathname with the locale segment stripped, as a reactive ComputedRef<string>. 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 Vue
Copy the code to the clipboard
import { usePathname } from "vue-intlayer";Overview
usePathname reads window.location.pathname, strips the locale prefix via getPathWithoutLocale, and updates automatically when the browser fires a popstate event (back/forward navigation). The result is exposed as a ComputedRef<string> so it integrates naturally with Vue's reactivity system.
Usage
Copy the code to the clipboard
<script setup lang="ts">import { usePathname } from "vue-intlayer";const props = defineProps<{ href: string; label: string;}>();const pathname = usePathname();</script><template> <a :href="href" :aria-current="pathname === href ? 'page' : undefined"> {{ label }} </a></template>Return Value
Open the table in a modal to view all data content clearly
| Type | Description |
|---|---|
ComputedRef<string> | Reactive computed ref containing the current pathname without the locale prefix. |
Behavior
- Locale stripping: Removes the leading locale segment (e.g.
/fr/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 is unmounted (onUnmounted).
Example
Copy the code to the clipboard
<script setup lang="ts">import { usePathname } from "vue-intlayer";const links = [ { href: "/dashboard", label: "Dashboard" }, { href: "/settings", label: "Settings" },];const pathname = usePathname();</script><template> <nav> <a v-for="link in links" :key="link.href" :href="link.href" :style="{ fontWeight: pathname === link.href ? 'bold' : 'normal' }" > {{ link.label }} </a> </nav></template>Related
useLocale— current locale + locale switchergetPathWithoutLocale— the underlying utility used by this composable