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

package/docs/en/packages/intlayer/comparePaths.md

@@ -0,0 +1,173 @@
+---
+createdAt: 2026-06-22
+updatedAt: 2026-06-22
+title: comparePaths Function Documentation | intlayer
+description: See how to use the comparePaths function for intlayer package
+keywords:
+  - comparePaths
+  - normalizePath
+  - active link
+  - navigation
+  - Intlayer
+  - intlayer
+  - Internationalization
+  - Documentation
+  - Next.js
+  - JavaScript
+  - React
+slugs:
+  - doc
+  - packages
+  - intlayer
+  - comparePaths
+history:
+  - version: 9.0.0
+    date: 2026-06-22
+    changes: "Initial documentation"
+author: aymericzip
+---
+
+# Documentation: `comparePaths` Function in `intlayer`
+
+## Description
+
+The `comparePaths` function compares two URLs or pathnames for equality while ignoring the locale segment, the protocol/host, the query string, the hash and trailing slashes. It is the recommended way to determine whether a navigation link points to the current page — for example to highlight the active link — without having to roll your own (error-prone) normalization logic.
+
+Internally it reuses [`getPathWithoutLocale`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/packages/intlayer/getPathWithoutLocale.md) to strip the locale segment, so it respects your configured routing mode and locales.
+
+The package also exports the underlying [`normalizePath`](#normalizepath) helper, which returns the canonical, locale-agnostic pathname used for the comparison.
+
+**Key Features:**
+
+- Locale-agnostic comparison (`/fr/about` matches `/about`)
+- Works with both absolute URLs and relative pathnames
+- Ignores query string, hash and trailing slashes
+- Tolerates missing leading slashes and empty values (normalized to `/`)
+- Lightweight — built on top of `getPathWithoutLocale`
+
+---
+
+## Function Signature
+
+```typescript
+comparePaths(
+  pathname: string,  // Required
+  href: string,      // Required
+  locales?: Locales[] // Optional
+): boolean
+
+normalizePath(
+  inputUrl: string,   // Required
+  locales?: Locales[] // Optional
+): string
+```
+
+---
+
+## Parameters
+
+- `pathname: string`
+  - **Description**: The first URL string or pathname to compare (typically the current pathname).
+  - **Type**: `string`
+  - **Required**: Yes
+
+- `href: string`
+  - **Description**: The second URL string or pathname to compare (typically a navigation link's `href`).
+  - **Type**: `string`
+  - **Required**: Yes
+
+- `locales: Locales[]`
+  - **Description**: Optional array of supported locales. Defaults to the configured locales in the project.
+  - **Type**: `Locales[]`
+  - **Required**: No (Optional)
+
+### Returns
+
+- **Type**: `boolean`
+- **Description**: `true` when both inputs resolve to the same locale-agnostic path, otherwise `false`.
+
+---
+
+## Example Usage
+
+### Basic Usage
+
+```typescript codeFormat={["typescript", "esm", "commonjs"]}
+import { comparePaths } from "intlayer";
+
+comparePaths("/ru/path", "/path"); // true
+comparePaths("/ru/path/", "/path"); // true
+comparePaths("/ru/path", "/path/"); // true
+comparePaths("/ru/", "/"); // true
+comparePaths("/ru", "/"); // true
+comparePaths("ru/path", "/path"); // true
+comparePaths("", "/"); // true
+comparePaths("/ru", ""); // true
+comparePaths("/ru/path", "/other"); // false
+```
+
+### Absolute and relative URLs
+
+```typescript
+import { comparePaths } from "intlayer";
+
+comparePaths("https://example.com/ru/path", "/path"); // true
+```
+
+### Highlighting the active navigation link
+
+```tsx
+import { comparePaths } from "intlayer";
+import { useLocation } from "react-router";
+
+const NavLink = ({ href, children }) => {
+  const { pathname } = useLocation();
+  const isActive = comparePaths(pathname, href);
+
+  return (
+    <a href={href} aria-current={isActive ? "page" : undefined}>
+      {children}
+    </a>
+  );
+};
+```
+
+---
+
+## normalizePath
+
+`normalizePath` returns the canonical, locale-agnostic pathname used by `comparePaths`. It strips the locale segment, the protocol/host, the query string and the hash, ensures a single leading slash, removes any trailing slash (except for the root) and falls back to `/` for empty values.
+
+```typescript codeFormat={["typescript", "esm", "commonjs"]}
+import { normalizePath } from "intlayer";
+
+normalizePath("/ru/path"); // "/path"
+normalizePath("/ru/path/"); // "/path"
+normalizePath("ru/path"); // "/path"
+normalizePath("/ru/"); // "/"
+normalizePath("/ru"); // "/"
+normalizePath(""); // "/"
+normalizePath("https://example.com/ru/path"); // "/path"
+```
+
+---
+
+## Related Functions
+
+- [`getPathWithoutLocale`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/packages/intlayer/getPathWithoutLocale.md): Removes the locale segment from a URL or pathname.
+- [`getPrefix`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/packages/intlayer/getPrefix.md): Determines the URL prefix for a given locale.
+- [`getLocalizedUrl`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/packages/intlayer/getLocalizedUrl.md): Generates a localized URL for a specific locale.
+
+---
+
+## TypeScript
+
+```typescript
+function normalizePath(inputUrl: string, locales?: Locales[]): string;
+
+function comparePaths(
+  pathname: string,
+  href: string,
+  locales?: Locales[]
+): boolean;
+```

package/docs/en/packages/intlayer/exports.md

@@ -14,6 +14,9 @@ slugs:
   - intlayer
   - exports
 history:
+  - version: 9.0.0
+    date: 2026-06-23
+    changes: "Add comparePaths utility"
   - version: 8.0.0
     date: 2026-01-21
     changes: "Unified documentation for all exports"
@@ -108,19 +111,21 @@ Import:
 import "intlayer";
 ```
 
-| Function               | Type       | Description                               | Related Doc                                                                                                                     |
-| ---------------------- | ---------- | ----------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
-| `getLocale`            | `Function` | Detects the locale from a string or path. | [getLocale](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/packages/intlayer/getLocale.md)                       |
-| `getLocaleLang`        | `Function` | Gets the language part of a locale.       | [getLocaleLang](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/packages/intlayer/getLocaleLang.md)               |
-| `getLocaleName`        | `Function` | Gets the display name of a locale.        | [getLocaleName](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/packages/intlayer/getLocaleName.md)               |
-| `getLocalizedPath`     | `Function` | Resolves a canonical path to localized.   | [getLocalizedPath](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/packages/intlayer/getLocalizedPath.md)         |
-| `getCanonicalPath`     | `Function` | Resolves a localized path to canonical.   | [getCanonicalPath](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/packages/intlayer/getCanonicalPath.md)         |
-| `getLocalizedUrl`      | `Function` | Generates a localized URL.                | [getLocalizedUrl](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/packages/intlayer/getLocalizedUrl.md)           |
-| `getMultilingualUrls`  | `Function` | Generates URLs for all supported locales. | [getMultilingualUrls](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/packages/intlayer/getMultilingualUrls.md)   |
-| `getPathWithoutLocale` | `Function` | Removes the locale prefix from a path.    | [getPathWithoutLocale](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/packages/intlayer/getPathWithoutLocale.md) |
-| `getPrefix`            | `Function` | Gets the locale prefix from a path.       | [getPrefix](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/packages/intlayer/getPrefix.md)                       |
-| `getHTMLTextDir`       | `Function` | Gets the text direction (LTR/RTL).        | [getHTMLTextDir](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/packages/intlayer/getHTMLTextDir.md)             |
-| `validatePrefix`       | `Function` | Validates a locale prefix.                | [validatePrefix](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/packages/intlayer/validatePrefix.md)             |
+| Function               | Type       | Description                                 | Related Doc                                                                                                                     |
+| ---------------------- | ---------- | ------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
+| `getLocale`            | `Function` | Detects the locale from a string or path.   | [getLocale](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/packages/intlayer/getLocale.md)                       |
+| `getLocaleLang`        | `Function` | Gets the language part of a locale.         | [getLocaleLang](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/packages/intlayer/getLocaleLang.md)               |
+| `getLocaleName`        | `Function` | Gets the display name of a locale.          | [getLocaleName](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/packages/intlayer/getLocaleName.md)               |
+| `getLocalizedPath`     | `Function` | Resolves a canonical path to localized.     | [getLocalizedPath](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/packages/intlayer/getLocalizedPath.md)         |
+| `getCanonicalPath`     | `Function` | Resolves a localized path to canonical.     | [getCanonicalPath](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/packages/intlayer/getCanonicalPath.md)         |
+| `getLocalizedUrl`      | `Function` | Generates a localized URL.                  | [getLocalizedUrl](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/packages/intlayer/getLocalizedUrl.md)           |
+| `getMultilingualUrls`  | `Function` | Generates URLs for all supported locales.   | [getMultilingualUrls](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/packages/intlayer/getMultilingualUrls.md)   |
+| `getPathWithoutLocale` | `Function` | Removes the locale prefix from a path.      | [getPathWithoutLocale](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/packages/intlayer/getPathWithoutLocale.md) |
+| `getPrefix`            | `Function` | Gets the locale prefix from a path.         | [getPrefix](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/packages/intlayer/getPrefix.md)                       |
+| `comparePaths`         | `Function` | Compares two paths ignoring the locale.     | [comparePaths](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/packages/intlayer/comparePaths.md)                 |
+| `normalizePath`        | `Function` | Normalizes a path to a locale-agnostic one. | [comparePaths](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/packages/intlayer/comparePaths.md)                 |
+| `getHTMLTextDir`       | `Function` | Gets the text direction (LTR/RTL).          | [getHTMLTextDir](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/packages/intlayer/getHTMLTextDir.md)             |
+| `validatePrefix`       | `Function` | Validates a locale prefix.                  | [validatePrefix](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/packages/intlayer/validatePrefix.md)             |
 
 ### Browser Utilities
 

package/docs/en/packages/next-intlayer/exports.md

@@ -15,6 +15,9 @@ slugs:
   - next-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"
@@ -99,6 +102,7 @@ Re-exports most hooks from `react-intlayer`.
 | `useDictionaryAsync`   | Hook that handles asynchronous dictionaries. Accepts a promise-based dictionary map and resolves it for the current locale.               | -                                                                                                                       |
 | `useDictionaryDynamic` | Hook that handles dynamic dictionaries loaded by key. Uses React Suspense internally for loading states.                                  | -                                                                                                                       |
 | `useLocale`            | Client-side hook to get the current locale and a function to set it. Enhanced for Next.js App Router with navigation support.             | [useLocale](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/packages/react-intlayer/useLocale.md)         |
+| `usePathname`          | Hook that returns the current Next.js pathname with the locale segment removed. Wraps `next/navigation` `usePathname` and strips locale.  | [usePathname](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/packages/next-intlayer/usePathname.md)      |
 | `useRewriteURL`        | Client-side hook to manage URL rewrites. Automatically updates the URL if a prettier localized rewrite rule exists.                       | [useRewriteURL](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/packages/next-intlayer/useRewriteURL.md)  |
 | `useLocalePageRouter`  | Next.js Page Router specific hook for locale management. Handles redirections and page reloads upon locale changes.                       | -                                                                                                                       |
 | `useI18n`              | Hook that provides a translation function `t()` for accessing nested content by key. Mimics i18next/next-intl pattern.                    | [useI18n](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/packages/react-intlayer/useI18n.md)             |

package/docs/en/packages/next-intlayer/usePathname.md

@@ -0,0 +1,136 @@
+---
+createdAt: 2026-06-22
+updatedAt: 2026-06-22
+title: usePathname Hook Documentation | next-intlayer
+description: See how to use the usePathname hook for next-intlayer package
+keywords:
+  - usePathname
+  - pathname
+  - locale
+  - Intlayer
+  - Internationalization
+  - Documentation
+  - Next.js
+  - JavaScript
+  - React
+slugs:
+  - doc
+  - packages
+  - next-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
+---
+
+# Next.js Integration: `usePathname` Hook Documentation
+
+The `usePathname` hook returns the current Next.js 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 Next.js
+
+```typescript
+import { usePathname } from "next-intlayer";
+```
+
+## Overview
+
+`usePathname` wraps Next.js's built-in `usePathname()` from `next/navigation`, appends any search params, and strips the locale prefix via `getPathWithoutLocale`. It re-renders on every client-side navigation. The hook is available only in Client Components (requires `"use client"`).
+
+## Usage
+
+```tsx fileName="src/components/NavItem.tsx" codeFormat={["typescript", "esm"]}
+"use client";
+
+import type { FC } from "react";
+import { usePathname } from "next-intlayer";
+
+type NavItemProps = {
+  href: string;
+  label: string;
+};
+
+const NavItem: FC<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
+
+| Type     | Description                                                                                         |
+| -------- | --------------------------------------------------------------------------------------------------- |
+| `string` | The current pathname without the locale prefix and query params stripped of their locale parameter. |
+
+## Behavior
+
+- **Locale stripping**: Removes the leading locale segment (e.g. `/en/dashboard` → `/dashboard`).
+- **Search param stripping**: Also strips a `?locale=...` query parameter when search-params routing mode is used.
+- **Reactive**: Updates on every client-side navigation via Next.js App Router.
+- **SSR-safe**: Returns the server-side pathname during the first render, then syncs search params on the client.
+
+## Comparison with `useLocale`
+
+`useLocale` from `next-intlayer` already exposes `pathWithoutLocale` as part of its return value. Use `usePathname` when you only need the path and do not need locale switching functionality.
+
+```tsx codeFormat={["typescript", "esm"]}
+// When you need both locale state and the path:
+import { useLocale } from "next-intlayer";
+const { locale, pathWithoutLocale } = useLocale();
+
+// When you only need the path:
+import { usePathname } from "next-intlayer";
+const pathname = usePathname();
+```
+
+## Example
+
+```tsx fileName="src/components/Sidebar.tsx" codeFormat={["typescript", "esm"]}
+"use client";
+
+import type { FC } from "react";
+import { usePathname } from "next-intlayer";
+
+const links = [
+  { href: "/dashboard", label: "Dashboard" },
+  { href: "/settings", label: "Settings" },
+];
+
+const Sidebar: FC = () => {
+  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`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/packages/next-intlayer/useLocale.md) — current locale + locale switcher (also exposes `pathWithoutLocale`)
+- [`getPathWithoutLocale`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/packages/intlayer/getPathWithoutLocale.md) — the underlying utility used by this hook

package/docs/en/packages/preact-intlayer/exports.md

@@ -14,6 +14,9 @@ slugs:
   - preact-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"
@@ -40,12 +43,13 @@ npm install preact-intlayer
 
 ### Hooks
 
-| Hook            | Description                                                                                                       | Related Doc                                                                                            |
-| --------------- | ----------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------ |
-| `useIntlayer`   | Based on `useDictionary`, but injects an optimized version of the dictionary from the generated declaration.      | -                                                                                                      |
-| `useDictionary` | Processes objects that look like dictionaries (key, content). It processes `t()` translations, enumerations, etc. | -                                                                                                      |
-| `useLocale`     | Returns the current locale and a function to set it.                                                              | -                                                                                                      |
-| `t`             | Picks content based on the current locale.                                                                        | [translation](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/dictionary/translation.md) |
+| Hook            | Description                                                                                                            | Related Doc                                                                                                          |
+| --------------- | ---------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
+| `useIntlayer`   | Based on `useDictionary`, but injects an optimized version of the dictionary from the generated declaration.           | -                                                                                                                    |
+| `useDictionary` | Processes objects that look like dictionaries (key, content). It processes `t()` translations, enumerations, etc.      | -                                                                                                                    |
+| `useLocale`     | Returns the current locale and a function to set it.                                                                   | -                                                                                                                    |
+| `usePathname`   | Hook that returns the current pathname with the locale segment removed. Reactive to browser navigation via `popstate`. | [usePathname](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/packages/preact-intlayer/usePathname.md) |
+| `t`             | Picks content based on the current locale.                                                                             | [translation](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/dictionary/translation.md)               |
 
 ### Components
 

package/docs/en/packages/preact-intlayer/usePathname.md

@@ -0,0 +1,117 @@
+---
+createdAt: 2026-06-22
+updatedAt: 2026-06-22
+title: usePathname Hook Documentation | preact-intlayer
+description: See how to use the usePathname hook for preact-intlayer package
+keywords:
+  - usePathname
+  - pathname
+  - locale
+  - Intlayer
+  - Internationalization
+  - Documentation
+  - Preact
+  - JavaScript
+slugs:
+  - doc
+  - packages
+  - preact-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
+---
+
+# 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
+
+```typescript
+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
+
+```tsx fileName="src/components/NavItem.tsx"
+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
+
+| Type     | Description                                                                                |
+| -------- | ------------------------------------------------------------------------------------------ |
+| `string` | The current pathname without the locale prefix. Empty string during server-side rendering. |
+
+## Behavior
+
+- **Locale stripping**: Removes the leading locale segment (e.g. `/en/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 when the component unmounts.
+
+## Example
+
+```tsx fileName="src/components/Sidebar.tsx"
+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`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/packages/preact-intlayer/exports.md) — current locale + locale switcher
+- [`getPathWithoutLocale`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/packages/intlayer/getPathWithoutLocale.md) — the underlying utility used by this hook

package/docs/en/packages/react-intlayer/exports.md

@@ -14,6 +14,9 @@ slugs:
   - react-intlayer
   - exports
 history:
+  - version: 10.0.0
+    date: 2026-06-23
+    changes: "Add usePathname utility"
   - version: 7.5.14
     date: 2026-01-21
     changes: "Unified documentation for all exports"
@@ -64,6 +67,7 @@ import "react-intlayer";
 | `useDictionaryDynamic` | Hook that handles dynamic dictionaries loaded by key. Uses React Suspense internally for loading states.                                  | -                                                                                                                       |
 | `useLocale`            | Client-side hook to get the current locale, default locale, available locales, and a function to update the locale.                       | [useLocale](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/packages/react-intlayer/useLocale.md)         |
 | `useLocaleBase`        | Hook to get the current locale and all related fields (locale, defaultLocale, availableLocales, setLocale) from context.                  | -                                                                                                                       |
+| `usePathname`          | Hook that returns the current pathname with the locale segment removed. Reactive to browser navigation via `popstate`.                    | [usePathname](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/packages/react-intlayer/usePathname.md)     |
 | `useRewriteURL`        | Client-side hook to manage URL rewrites. If a rewrite rule exists for the current pathname and locale, it will update the URL.            | [useRewriteURL](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/packages/react-intlayer/useRewriteURL.md) |
 | `useI18n`              | Hook that provides a translation function `t()` for accessing nested content by key. Mimics i18next/next-intl pattern.                    | [useI18n](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/packages/react-intlayer/useI18n.md)             |
 | `useIntl`              | Hook that provides a locale-bound `Intl` object. Automatically injects the current locale and uses optimized caching.                     | -                                                                                                                       |

package/docs/en/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
+  - internationalization
+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: "Initialize 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` 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/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 current pathname of the browser with the locale prefix removed (e.g., `/fr/dashboard` → `/dashboard`). |
+
+## Behavior
+
+- **Locale Stripping**: Uses the `getPathWithoutLocale` utility under the hood 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 browser back/forward buttons or when `pushState`/`replaceState` is called, the hook updates the returned pathname.
+- **SSR Fallback**: On the server (where `window` is undefined), it defaults to returning `/` since it has no 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/packages/react-intlayer/useLocale.md)
+- [`getPathWithoutLocale`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/packages/intlayer/getPathWithoutLocale.md)

package/docs/en/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"
@@ -59,6 +62,7 @@ import "solid-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.                                                              | [useLocale](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/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/packages/solid-intlayer/usePathname.md)     |
 | `useRewriteURL`        | Client-side hook to manage URL rewrites. Automatically updates the URL if a localized rewrite rule exists.        | [useRewriteURL](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/packages/solid-intlayer/useRewriteURL.md) |
 | `useIntl`              | Returns the Intl object for the current locale.                                                                   | -                                                                                                                       |
 | `useLoadDynamic`       | Hook to load dynamic dictionaries.                                                                                | -                                                                                                                       |