@intlayer/docs 9.0.0-canary.2 → 9.0.0-canary.4

package/docs/en-GB/packages/react-intlayer/usePathname.md

@@ -0,0 +1,87 @@
+---
+createdAt: 2026-06-22
+updatedAt: 2026-06-22
+title: usePathname Hook Documentation | react-intlayer
+description: Learn how to use the usePathname hook from the react-intlayer package to get the current URL pathname without the locale segment.
+keywords:
+  - usePathname
+  - pathname
+  - react
+  - intlayer
+  - routing
+  - internationalisation
+slugs:
+  - doc
+  - packages
+  - react-intlayer
+  - usePathname
+history:
+  - version: 10.0.0
+    date: 2026-06-23
+    changes: "Add usePathname utility"
+  - version: 8.2.0
+    date: 2026-06-22
+    changes: "Initialise history"
+author: aymericzip
+---
+
+# React Integration: `usePathname` Hook Documentation
+
+The `usePathname` hook from `react-intlayer` returns the current browser pathname with the locale segment removed. It relies on the native `window.location.pathname` property and reacts to browser navigation events via `popstate`.
+
+## Importing `usePathname`
+
+```typescript
+import { usePathname } from "react-intlayer";
+```
+
+## Overview
+
+Unlike framework-specific routing hooks (such as those in `next-intlayer` or `react-router`), this hook is a lightweight, framework-agnostic solution for plain React applications. It extracts the current URL and strips any matching locale prefix (e.g., `/en-GB/about` becomes `/about`).
+
+## Usage
+
+```tsx fileName="src/components/Navigation.tsx" codeFormat={["typescript", "esm"]}
+import type { FC } from "react";
+import { usePathname } from "react-intlayer";
+
+const Navigation: FC = () => {
+  const pathname = usePathname();
+
+  return (
+    <nav>
+      <a
+        href="/home"
+        style={{ fontWeight: pathname === "/home" ? "bold" : "normal" }}
+      >
+        Home
+      </a>
+      <a
+        href="/about"
+        style={{ fontWeight: pathname === "/about" ? "bold" : "normal" }}
+      >
+        About
+      </a>
+    </nav>
+  );
+};
+
+export default Navigation;
+```
+
+## Return Value
+
+| Type     | Description                                                                                             |
+| -------- | ------------------------------------------------------------------------------------------------------- |
+| `string` | The browser's current pathname with the locale prefix removed (e.g. `/en-GB/dashboard` → `/dashboard`). |
+
+## Behaviour
+
+- **Locale Stripping**: Under the hood, it uses the `getPathWithoutLocale` utility to automatically detect and remove the locale from the pathname based on the application's Intlayer configuration.
+- **Reactivity**: Listens to the `popstate` event. When the user navigates using the browser's back/forward buttons, or when `pushState`/`replaceState` are called, the hook updates the returned pathname.
+- **SSR Fallback**: On the server (where `window` is undefined), it defaults to returning `/` since it does not have access to the request URL by default in a pure React context.
+
+## Related Documentation
+
+- [`useLocale`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en-GB/packages/react-intlayer/useLocale.md)
+- [`getPathWithoutLocale`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en-GB/packages/intlayer/getPathWithoutLocale.md)

package/docs/en-GB/packages/solid-intlayer/exports.md

@@ -14,6 +14,9 @@ slugs:
   - solid-intlayer
   - exports
 history:
+  - version: 10.0.0
+    date: 2026-06-23
+    changes: "Add usePathname utility"
   - version: 8.0.0
     date: 2026-01-21
     changes: "Unified documentation for all exports"
@@ -52,17 +55,18 @@ Import:
 import "solid-intlayer";
 ```
 
-| Hook                   | Description                                                                                                  | Related Doc                                                                                                                |
-| ---------------------- | ------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------- |
-| `useIntlayer`          | Based on `useDictionary`, but injects an optimised version of the dictionary from the generated declaration. | [useIntlayer](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en-GB/packages/solid-intlayer/useIntlayer.md)     |
-| `useDictionary`        | Processes objects resembling dictionaries (key, content). Handles `t()` translations, enumerations, etc.     | -                                                                                                                          |
-| `useDictionaryAsync`   | Same as `useDictionary`, but handles asynchronous dictionaries.                                              | -                                                                                                                          |
-| `useDictionaryDynamic` | Same as `useDictionary`, but handles dynamic dictionaries.                                                   | -                                                                                                                          |
-| `useLocale`            | Returns the current locale and a function to set it.                                                         | [useLocale](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en-GB/packages/solid-intlayer/useLocale.md)         |
-| `useRewriteURL`        | Client-side hook to manage URL rewrites. Automatically updates the URL if a localised rewrite rule exists.   | [useRewriteURL](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en-GB/packages/solid-intlayer/useRewriteURL.md) |
-| `useIntl`              | Returns the Intl object for the current locale.                                                              | -                                                                                                                          |
-| `useLoadDynamic`       | Hook to load dynamic dictionaries.                                                                           | -                                                                                                                          |
-| `t`                    | Selects content based on the current locale.                                                                 | [translation](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en-GB/dictionary/translation.md)                  |
+| Hook                   | Description                                                                                                    | Related Doc                                                                                                                |
+| ---------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- |
+| `useIntlayer`          | Based on `useDictionary`, but injects an optimised version of the dictionary from the generated declaration.   | [useIntlayer](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en-GB/packages/solid-intlayer/useIntlayer.md)     |
+| `useDictionary`        | Processes objects resembling dictionaries (key, content). Handles `t()` translations, enumerations, etc.       | -                                                                                                                          |
+| `useDictionaryAsync`   | Same as `useDictionary`, but handles asynchronous dictionaries.                                                | -                                                                                                                          |
+| `useDictionaryDynamic` | Same as `useDictionary`, but handles dynamic dictionaries.                                                     | -                                                                                                                          |
+| `useLocale`            | Returns the current locale and a function to set it.                                                           | [useLocale](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en-GB/packages/solid-intlayer/useLocale.md)         |
+| `usePathname`          | Returns the current pathname as an `Accessor<string>` with the locale segment removed. Reactive to `popstate`. | [usePathname](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en-GB/packages/solid-intlayer/usePathname.md)     |
+| `useRewriteURL`        | Client-side hook to manage URL rewrites. Automatically updates the URL if a localised rewrite rule exists.     | [useRewriteURL](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en-GB/packages/solid-intlayer/useRewriteURL.md) |
+| `useIntl`              | Returns the Intl object for the current locale.                                                                | -                                                                                                                          |
+| `useLoadDynamic`       | Hook to load dynamic dictionaries.                                                                             | -                                                                                                                          |
+| `t`                    | Selects content based on the current locale.                                                                   | [translation](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en-GB/dictionary/translation.md)                  |
 
 ### Components
 

package/docs/en-GB/packages/solid-intlayer/usePathname.md

@@ -0,0 +1,119 @@
+---
+createdAt: 2026-06-22
+updatedAt: 2026-06-22
+title: usePathname Hook Documentation | solid-intlayer
+description: See how to use the usePathname hook for solid-intlayer package
+keywords:
+  - usePathname
+  - pathname
+  - locale
+  - Intlayer
+  - Internationalisation
+  - Documentation
+  - Solid
+  - Solid.js
+  - JavaScript
+slugs:
+  - doc
+  - packages
+  - solid-intlayer
+  - usePathname
+history:
+  - version: 10.0.0
+    date: 2026-06-23
+    changes: "Add usePathname utility"
+  - version: 8.2.0
+    date: 2026-06-22
+    changes: "Init history"
+author: aymericzip
+---
+
+# Solid Integration: `usePathname` Hook Documentation
+
+The `usePathname` hook returns the current browser pathname with the locale segment stripped, as a Solid `Accessor<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 Solid
+
+```typescript
+import { usePathname } from "solid-intlayer";
+```
+
+## Overview
+
+`usePathname` creates a reactive signal initialised from `window.location.pathname`, strips the locale prefix via `getPathWithoutLocale`, and updates the signal whenever the browser fires a `popstate` event (back/forward navigation). The event listener is cleaned up automatically via `onCleanup`.
+
+## Usage
+
+```tsx fileName="src/components/NavItem.tsx"
+import type { Component } from "solid-js";
+import { usePathname } from "solid-intlayer";
+
+type NavItemProps = {
+  href: string;
+  label: string;
+};
+
+const NavItem: Component<NavItemProps> = ({ href, label }) => {
+  const pathname = usePathname();
+
+  return (
+    <a href={href} aria-current={pathname() === href ? "page" : undefined}>
+      {label}
+    </a>
+  );
+};
+
+export default NavItem;
+```
+
+## Return Value
+
+| Type               | Description                                                                                |
+| ------------------ | ------------------------------------------------------------------------------------------ |
+| `Accessor<string>` | Solid accessor (reactive getter) returning the current pathname without the locale prefix. |
+
+## Behaviour
+
+- **Locale stripping**: Removes the leading locale segment (e.g. `/en-GB/dashboard` → `/dashboard`).
+- **Reactive**: Updates automatically on `popstate` events (browser back / forward navigation).
+- **SSR-safe**: Returns `""` when `window` is not available.
+- **Cleanup**: The `popstate` listener is removed automatically via Solid's `onCleanup`.
+
+## Example
+
+```tsx fileName="src/components/Sidebar.tsx"
+import type { Component } from "solid-js";
+import { For } from "solid-js";
+import { usePathname } from "solid-intlayer";
+
+const links = [
+  { href: "/dashboard", label: "Dashboard" },
+  { href: "/settings", label: "Settings" },
+];
+
+const Sidebar: Component = () => {
+  const pathname = usePathname();
+
+  return (
+    <nav>
+      <For each={links}>
+        {({ href, label }) => (
+          <a
+            href={href}
+            style={{ "font-weight": pathname() === href ? "bold" : "normal" }}
+          >
+            {label}
+          </a>
+        )}
+      </For>
+    </nav>
+  );
+};
+
+export default Sidebar;
+```
+
+## Related
+
+- [`useLocale`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en-GB/packages/solid-intlayer/useLocale.md) — current locale + locale switcher
+- [`getPathWithoutLocale`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en-GB/packages/intlayer/getPathWithoutLocale.md) — the underlying utility used by this hook

package/docs/en-GB/packages/svelte-intlayer/exports.md

@@ -14,6 +14,9 @@ slugs:
   - svelte-intlayer
   - exports
 history:
+  - version: 10.0.0
+    date: 2026-06-23
+    changes: "Add usePathname utility"
   - version: 8.0.0
     date: 2026-01-21
     changes: "Unified documentation for all exports"
@@ -64,15 +67,16 @@ Import:
 import "svelte-intlayer";
 ```
 
-| Function               | Description                                                                                                      | Related Doc                                                                                                                 |
-| ---------------------- | ---------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- |
-| `useIntlayer`          | Based on `useDictionary`, but injects an optimised version of the dictionary from the generated declaration.     | -                                                                                                                           |
-| `useDictionary`        | Processes objects that resemble dictionaries (key, content). It processes `t()` translations, enumerations, etc. | -                                                                                                                           |
-| `useDictionaryAsync`   | Same as `useDictionary`, but handles asynchronous dictionaries.                                                  | -                                                                                                                           |
-| `useDictionaryDynamic` | Same as `useDictionary`, but handles dynamic dictionaries.                                                       | -                                                                                                                           |
-| `useLocale`            | Returns the current locale and a function to set it.                                                             | -                                                                                                                           |
-| `useRewriteURL`        | Client-side function to manage URL rewrites. Automatically updates the URL if a localised rewrite rule exists.   | [useRewriteURL](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en-GB/packages/svelte-intlayer/useRewriteURL.md) |
-| `useIntl`              | Returns the Intl object for the current locale.                                                                  | -                                                                                                                           |
+| Function               | Description                                                                                                         | Related Doc                                                                                                                 |
+| ---------------------- | ------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- |
+| `useIntlayer`          | Based on `useDictionary`, but injects an optimised version of the dictionary from the generated declaration.        | -                                                                                                                           |
+| `useDictionary`        | Processes objects that resemble dictionaries (key, content). It processes `t()` translations, enumerations, etc.    | -                                                                                                                           |
+| `useDictionaryAsync`   | Same as `useDictionary`, but handles asynchronous dictionaries.                                                     | -                                                                                                                           |
+| `useDictionaryDynamic` | Same as `useDictionary`, but handles dynamic dictionaries.                                                          | -                                                                                                                           |
+| `useLocale`            | Returns the current locale and a function to set it.                                                                | -                                                                                                                           |
+| `usePathname`          | Returns the current pathname as a `Readable<string>` store with the locale segment removed. Reactive to `popstate`. | [usePathname](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en-GB/packages/svelte-intlayer/usePathname.md)     |
+| `useRewriteURL`        | Client-side function to manage URL rewrites. Automatically updates the URL if a localised rewrite rule exists.      | [useRewriteURL](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en-GB/packages/svelte-intlayer/useRewriteURL.md) |
+| `useIntl`              | Returns the Intl object for the current locale.                                                                     | -                                                                                                                           |
 
 ### Markdown
 

package/docs/en-GB/packages/svelte-intlayer/usePathname.md

@@ -0,0 +1,103 @@
+---
+createdAt: 2026-06-22
+updatedAt: 2026-06-22
+title: usePathname Function Documentation | svelte-intlayer
+description: See how to use the usePathname function for svelte-intlayer package
+keywords:
+  - usePathname
+  - pathname
+  - locale
+  - Intlayer
+  - Internationalisation
+  - Documentation
+  - Svelte
+  - JavaScript
+slugs:
+  - doc
+  - packages
+  - svelte-intlayer
+  - usePathname
+history:
+  - version: 10.0.0
+    date: 2026-06-23
+    changes: "Add usePathname utility"
+  - version: 8.2.0
+    date: 2026-06-22
+    changes: "Init history"
+author: aymericzip
+---
+
+# Svelte Integration: `usePathname` Documentation
+
+The `usePathname` function returns the current browser pathname with the locale segment stripped, as a Svelte `Readable<string>` store. 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 Svelte
+
+```typescript
+import { usePathname } from "svelte-intlayer";
+```
+
+## Overview
+
+`usePathname` creates a Svelte readable store that reads `window.location.pathname`, strips the locale prefix via `getPathWithoutLocale`, and emits a new value whenever the browser fires a `popstate` event (back/forward navigation). Subscribe with the `$` store syntax in components.
+
+## Usage
+
+```svelte fileName="src/components/NavItem.svelte"
+<script lang="ts">
+  import { usePathname } from "svelte-intlayer";
+
+  export let href: string;
+  export let label: string;
+
+  const pathname = usePathname();
+</script>
+
+<a {href} aria-current={$pathname === href ? "page" : undefined}>
+  {label}
+</a>
+```
+
+## Return Value
+
+| Type               | Description                                                                      |
+| ------------------ | -------------------------------------------------------------------------------- |
+| `Readable<string>` | Svelte readable store containing the current pathname without the locale prefix. |
+
+## Behaviour
+
+- **Locale stripping**: Removes the leading locale segment (e.g. `/en-GB/dashboard` → `/dashboard`).
+- **Reactive**: Emits a new value on every `popstate` event (browser back / forward navigation).
+- **SSR-safe**: Returns `""` when `window` is not available.
+- **Cleanup**: The `popstate` listener is removed automatically when the last subscriber unsubscribes.
+
+## Example
+
+```svelte fileName="src/components/Sidebar.svelte"
+<script lang="ts">
+  import { usePathname } from "svelte-intlayer";
+
+  const links = [
+    { href: "/dashboard", label: "Dashboard" },
+    { href: "/settings", label: "Settings" },
+  ];
+
+  const pathname = usePathname();
+</script>
+
+<nav>
+  {#each links as link}
+    <a
+      href={link.href}
+      style:font-weight={$pathname === link.href ? "bold" : "normal"}
+    >
+      {link.label}
+    </a>
+  {/each}
+</nav>
+```
+
+## Related
+
+- [`useLocale`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en-GB/packages/svelte-intlayer/useLocale.md) — current locale + locale switcher
+- [`getPathWithoutLocale`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en-GB/packages/intlayer/getPathWithoutLocale.md) — the underlying utility used by this hook

package/docs/en-GB/packages/vue-intlayer/exports.md

@@ -14,6 +14,9 @@ slugs:
   - vue-intlayer
   - exports
 history:
+  - version: 10.0.0
+    date: 2026-06-23
+    changes: "Add usePathname utility"
   - version: 8.0.0
     date: 2026-01-21
     changes: "Unified documentation for all exports"
@@ -59,6 +62,7 @@ import "vue-intlayer";
 | `useDictionaryAsync`   | Same as `useDictionary`, but handles asynchronous dictionaries.                                                  | -                                                                                                                        |
 | `useDictionaryDynamic` | Same as `useDictionary`, but handles dynamic dictionaries.                                                       | -                                                                                                                        |
 | `useLocale`            | Returns the current locale and a function to set it.                                                             | -                                                                                                                        |
+| `usePathname`          | Returns the current pathname as a `ComputedRef<string>` with the locale segment removed. Reactive to `popstate`. | [usePathname](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en-GB/packages/vue-intlayer/usePathname.md)     |
 | `useRewriteURL`        | Client-side composable to manage URL rewrites. Automatically updates the URL if a localised rewrite rule exists. | [useRewriteURL](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en-GB/packages/vue-intlayer/useRewriteURL.md) |
 | `useIntl`              | Returns the Intl object for the current locale.                                                                  | -                                                                                                                        |
 | `useLoadDynamic`       | Composable to load dynamic dictionaries.                                                                         | -                                                                                                                        |

package/docs/en-GB/packages/vue-intlayer/usePathname.md

@@ -0,0 +1,109 @@
+---
+createdAt: 2026-06-22
+updatedAt: 2026-06-22
+title: usePathname Function Documentation | vue-intlayer
+description: Learn how to use the usePathname function from the vue-intlayer package
+keywords:
+  - usePathname
+  - pathname
+  - locale
+  - Intlayer
+  - Internationalisation
+  - Documentation
+  - Vue
+  - JavaScript
+slugs:
+  - doc
+  - packages
+  - vue-intlayer
+  - usePathname
+history:
+  - version: 10.0.0
+    date: 2026-06-23
+    changes: "Add usePathname utility"
+  - version: 8.2.0
+    date: 2026-06-22
+    changes: "Initialise history"
+author: aymericzip
+---
+
+# Vue Integration: `usePathname` Documentation
+
+The `usePathname` function returns the current browser pathname with the locale segment removed, as a Vue `ComputedRef<string>`. This is useful for building locale-aware navigation—for example, to determine which nav item is active—without having to strip off the locale prefix manually.
+
+## Importing `usePathname` in Vue
+
+```typescript
+import { usePathname } from "vue-intlayer";
+```
+
+## Overview
+
+`usePathname` creates a Vue computed ref that reads `window.location.pathname`, removes the locale prefix via `getPathWithoutLocale`, and updates its value whenever the browser fires a `popstate` event (back/forward navigation). The value can be used directly in your Vue templates or setup functions.
+
+## Usage
+
+```vue fileName="src/components/NavItem.vue"
+<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
+
+| Type                  | Description                                                                         |
+| --------------------- | ----------------------------------------------------------------------------------- |
+| `ComputedRef<string>` | Vue Computed Ref containing the current browser pathname without the locale prefix. |
+
+## Behaviour
+
+- **Locale stripping**: Removes the leading locale segment (e.g. `/en-GB/dashboard` → `/dashboard`).
+- **Reactive**: Updates the value on every `popstate` event (browser back / forward navigation).
+- **SSR-safe**: Returns `""` when `window` is unavailable.
+- **Cleanup**: The `popstate` listener is added globally upon initialisation and typically does not require manual per-component cleanup, thanks to how Vue manages the lifecycle.
+
+## Example
+
+```vue fileName="src/components/Sidebar.vue"
+<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`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en-GB/packages/vue-intlayer/useLocale.md) — current locale + locale switcher
+- [`getPathWithoutLocale`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en-GB/packages/intlayer/getPathWithoutLocale.md) — the underlying utility used by this hook