@intlayer/docs 8.12.5-canary.0 → 9.0.0-canary.10

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

@@ -0,0 +1,173 @@
+---
+createdAt: 2026-06-22
+updatedAt: 2026-06-22
+title: comparePaths 函数文档 | intlayer
+description: 了解如何使用 intlayer 包中的 comparePaths 函数
+keywords:
+  - comparePaths
+  - normalizePath
+  - 活跃链接
+  - 导航
+  - Intlayer
+  - intlayer
+  - 国际化
+  - 文档
+  - Next.js
+  - JavaScript
+  - React
+slugs:
+  - doc
+  - packages
+  - intlayer
+  - comparePaths
+history:
+  - version: 9.0.0
+    date: 2026-06-22
+    changes: "初始文档"
+author: aymericzip
+---
+
+# 文档: `intlayer` 中的 `comparePaths` 函数
+
+## 描述
+
+`comparePaths` 函数在忽略区域设置（locale）段、协议/主机名、查询字符串、哈希值和尾部斜杠的情况下，比较两个 URL 或路径是否相等。这是确定导航链接是否指向当前页面的推荐方法（例如，用于高亮显示活动链接），而无需编写自己（容易出错）的规范化逻辑。
+
+它在内部重用了 [`getPathWithoutLocale`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/packages/intlayer/getPathWithoutLocale.md) 来去除区域设置段，因此它会遵循您配置的路由模式和区域设置。
+
+该包还导出了底层的 [`normalizePath`](#normalizepath) 辅助函数，它返回用于比较的、与区域设置无关的规范路径名。
+
+**主要特性：**
+
+- 与区域设置无关的比较（`/zh/about` 与 `/about` 匹配）
+- 适用于绝对 URL 和相对路径
+- 忽略查询字符串、哈希值和尾随斜杠
+- 容忍缺少前导斜杠和空值（规范化为 `/`）
+- 轻量级 — 构建在 `getPathWithoutLocale` 之上
+
+---
+
+## 函数签名
+
+```typescript
+comparePaths(
+  pathname: string,  // 必填
+  href: string,      // 必填
+  locales?: Locales[] // 可选
+): boolean
+
+normalizePath(
+  inputUrl: string,   // 必填
+  locales?: Locales[] // 可选
+): string
+```
+
+---
+
+## 参数
+
+- `pathname: string`
+  - **描述**: 要比较的第一个 URL 字符串或路径名（通常是当前路径）。
+  - **类型**: `string`
+  - **必填**: 是
+
+- `href: string`
+  - **描述**: 要比较的第二个 URL 字符串或路径名（通常是导航链接的 `href`）。
+  - **类型**: `string`
+  - **必填**: 是
+
+- `locales: Locales[]`
+  - **描述**: 支持的区域设置的可选数组。默认为项目中配置的区域设置。
+  - **类型**: `Locales[]`
+  - **必填**: 否 (可选)
+
+### 返回值
+
+- **类型**: `boolean`
+- **描述**: 当两个输入都解析为相同的与区域设置无关的路径时返回 `true`，否则返回 `false`。
+
+---
+
+## 示例用法
+
+### 基本用法
+
+```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
+```
+
+### 绝对和相对 URL
+
+```typescript
+import { comparePaths } from "intlayer";
+
+comparePaths("https://example.com/ru/path", "/path"); // true
+```
+
+### 高亮活动导航链接
+
+```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` 返回由 `comparePaths` 使用的、与区域设置无关的规范路径名。它去除了区域设置段、协议/主机、查询字符串和哈希，确保单个前导斜杠，删除任何尾随斜杠（根目录除外），对于空值则回退为 `/`。
+
+```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"
+```
+
+---
+
+## 相关函数
+
+- [`getPathWithoutLocale`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/packages/intlayer/getPathWithoutLocale.md): 从 URL 或路径中删除区域设置段。
+- [`getPrefix`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/packages/intlayer/getPrefix.md): 获取给定区域设置的 URL 前缀。
+- [`getLocalizedUrl`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/packages/intlayer/getLocalizedUrl.md): 为特定区域设置生成本地化 URL。
+
+---
+
+## TypeScript
+
+```typescript
+function normalizePath(inputUrl: string, locales?: Locales[]): string;
+
+function comparePaths(
+  pathname: string,
+  href: string,
+  locales?: Locales[]
+): boolean;
+```

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

@@ -14,6 +14,9 @@ slugs:
   - intlayer
   - exports
 history:
+  - version: 9.0.0
+    date: 2026-06-23
+    changes: "添加 comparePaths 实用工具"
   - version: 8.0.0
     date: 2026-01-21
     changes: "为所有导出统一文档"
@@ -108,19 +111,21 @@ import "intlayer";
 import "intlayer";
 ```
 
-| 函数                   | 类型       | 描述                             | 相关文档                                                                                                                        |
-| ---------------------- | ---------- | -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
-| `getLocale`            | `Function` | 从字符串或路径检测 locale。      | [getLocale](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/packages/intlayer/getLocale.md)                       |
-| `getLocaleLang`        | `Function` | 获取 locale 的语言部分。         | [getLocaleLang](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/packages/intlayer/getLocaleLang.md)               |
-| `getLocaleName`        | `Function` | 获取 locale 的显示名称。         | [getLocaleName](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/packages/intlayer/getLocaleName.md)               |
-| `getLocalizedPath`     | `Function` | 将规范路径解析为本地化路径。     | [getLocalizedPath](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/packages/intlayer/getLocalizedPath.md)         |
-| `getCanonicalPath`     | `Function` | 将本地化路径解析为规范路径。     | [getCanonicalPath](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/packages/intlayer/getCanonicalPath.md)         |
-| `getLocalizedUrl`      | `Function` | 生成本地化的 URL。               | [getLocalizedUrl](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/packages/intlayer/getLocalizedUrl.md)           |
-| `getMultilingualUrls`  | `Function` | 为所有受支持的 locale 生成 URL。 | [getMultilingualUrls](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/packages/intlayer/getMultilingualUrls.md)   |
-| `getPathWithoutLocale` | `Function` | 从路径中移除 locale 前缀。       | [getPathWithoutLocale](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/packages/intlayer/getPathWithoutLocale.md) |
-| `getPrefix`            | `Function` | 从路径获取 locale 前缀。         | [getPrefix](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/packages/intlayer/getPrefix.md)                       |
-| `getHTMLTextDir`       | `Function` | 获取文本方向（LTR/RTL）。        | [getHTMLTextDir](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/packages/intlayer/getHTMLTextDir.md)             |
-| `validatePrefix`       | `Function` | 验证区域设置前缀。               | [validatePrefix](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/packages/intlayer/validatePrefix.md)             |
+| 函数                   | 类型       | 描述                                 | 相关文档                                                                                                                        |
+| ---------------------- | ---------- | ------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------- |
+| `getLocale`            | `Function` | 从字符串或路径检测 locale。          | [getLocale](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/packages/intlayer/getLocale.md)                       |
+| `getLocaleLang`        | `Function` | 获取 locale 的语言部分。             | [getLocaleLang](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/packages/intlayer/getLocaleLang.md)               |
+| `getLocaleName`        | `Function` | 获取 locale 的显示名称。             | [getLocaleName](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/packages/intlayer/getLocaleName.md)               |
+| `getLocalizedPath`     | `Function` | 将规范路径解析为本地化路径。         | [getLocalizedPath](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/packages/intlayer/getLocalizedPath.md)         |
+| `getCanonicalPath`     | `Function` | 将本地化路径解析为规范路径。         | [getCanonicalPath](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/packages/intlayer/getCanonicalPath.md)         |
+| `getLocalizedUrl`      | `Function` | 生成本地化的 URL。                   | [getLocalizedUrl](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/packages/intlayer/getLocalizedUrl.md)           |
+| `getMultilingualUrls`  | `Function` | 为所有受支持的 locale 生成 URL。     | [getMultilingualUrls](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/packages/intlayer/getMultilingualUrls.md)   |
+| `getPathWithoutLocale` | `Function` | 从路径中移除 locale 前缀。           | [getPathWithoutLocale](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/packages/intlayer/getPathWithoutLocale.md) |
+| `getPrefix`            | `Function` | 从路径获取 locale 前缀。             | [getPrefix](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/packages/intlayer/getPrefix.md)                       |
+| `comparePaths`         | `Function` | 忽略区域设置比较两个路径。           | [comparePaths](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/packages/intlayer/comparePaths.md)                 |
+| `normalizePath`        | `Function` | 将路径规范化为与区域设置无关的路径。 | [comparePaths](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/packages/intlayer/comparePaths.md)                 |
+| `getHTMLTextDir`       | `Function` | 获取文本方向（LTR/RTL）。            | [getHTMLTextDir](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/packages/intlayer/getHTMLTextDir.md)             |
+| `validatePrefix`       | `Function` | 验证区域设置前缀。                   | [validatePrefix](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/packages/intlayer/validatePrefix.md)             |
 
 ### 浏览器工具
 

package/docs/zh/packages/intlayer/getLocalizedUrl.md

@@ -36,6 +36,36 @@ author: aymericzip
 
 ---
 
+## 函数签名
+
+```typescript
+getLocalizedUrl(
+  url: string,                   // 必需
+  currentLocale: Locales,        // 必需
+  options?: {                    // 可选
+    locales?: Locales[];
+    defaultLocale?: Locales;
+    mode?: 'prefix-no-default' | 'prefix-all' | 'no-prefix' | 'search-params';
+  }
+): string
+```
+
+---
+
+## 参数
+
+### 必需参数
+
+- `url: string`
+  - **Description**: 要用 locale 前缀的原始 URL 字符串。
+  - **Type**: `string`
+  - **Required**: Yes
+
+- `currentLocale: Locales`
+  - **Description**: 正在本地化 URL 的当前 locale。
+  - **Type**: `Locales`
+  - **Required**: Yes
+
 ## 参数
 
 - `url: string`
@@ -70,6 +100,25 @@ author: aymericzip
 
 ## 示例用法
 
+### 基本用法（仅需必需参数）
+
+当你使用国际化设置配置项目后，可以仅使用必需参数来调用该函数：
+
+```typescript codeFormat={["typescript", "esm", "commonjs"]}
+import { getLocalizedUrl, Locales } from "intlayer";
+
+// 使用你的项目配置中的 locales、defaultLocale 和 mode
+getLocalizedUrl("/about", Locales.FRENCH);
+// Output: "/fr/about" (假设支持法语且 mode 设置为 'prefix-no-default')
+
+getLocalizedUrl("/about", Locales.ENGLISH);
+// Output: "/about" 或 "/en/about" (取决于你的 mode 设置)
+```
+
+### 高级用法（带可选参数）
+
+您可以通过提供可选的 `options` 参数来覆盖默认配置：
+
 ### 相对 URL
 
 ```typescript codeFormat={["typescript", "esm"]}
@@ -117,6 +166,30 @@ getLocalizedUrl(
 // 输出: 对于默认（英语）区域，结果为 "/about"
 ```
 
+### 部分配置覆盖
+
+您也可以仅提供部分可选参数。该函数将对您未指定的任何参数使用您的项目配置：
+
+```typescript codeFormat="typescript"
+import { getLocalizedUrl, Locales } from "intlayer";
+
+// 仅覆盖 locales，使用项目配置中的 defaultLocale 和 mode
+getLocalizedUrl("/about", Locales.SPANISH, {
+  locales: [Locales.ENGLISH, Locales.FRENCH, Locales.SPANISH],
+});
+
+// 仅覆盖 mode，使用项目配置中的 locales 和 defaultLocale
+getLocalizedUrl("/about", Locales.ENGLISH, {
+  mode: "prefix-all", // 对所有语言（包括默认语言）强制添加前缀
+});
+
+// 覆盖多个选项
+getLocalizedUrl("/about", Locales.FRENCH, {
+  defaultLocale: Locales.ENGLISH,
+  mode: "search-params", // 使用查询参数：/about?locale=fr
+});
+```
+
 ### 绝对 URL
 
 ```typescript

package/docs/zh/packages/intlayer/getMultilingualUrls.md

@@ -33,6 +33,23 @@ author: aymericzip
 
 ---
 
+## 函数签名
+
+```typescript
+getMultilingualUrls(
+  url: string,                   // 必需
+  options?: {                    // 可选
+    locales?: Locales[];
+    defaultLocale?: Locales;
+    mode?: 'prefix-no-default' | 'prefix-all' | 'no-prefix' | 'search-params';
+  }
+): StrictModeLocaleMap<string>
+```
+
+---
+
+## 参数
+
 ## 参数
 
 - `url: string`
@@ -54,6 +71,33 @@ author: aymericzip
   - **类型**：`boolean`
   - **默认值**：`prefixDefaultDefault`
 
+### 可选参数
+
+- `options?: object`
+  - **Description**: URL 本地化行为的配置对象。
+  - **Type**: `object`
+  - **Required**: No (Optional)
+
+  - `options.locales?: Locales[]`
+    - **Description**: 支持的 locales 数组。如果未提供，将使用项目配置中的已配置 locales。
+    - **Type**: `Locales[]`
+    - **Default**: [`Project Configuration`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/configuration.md#middleware)
+
+  - `options.defaultLocale?: Locales`
+    - **Description**: 应用程序的默认 locale。如果未提供，将使用项目配置中的已配置默认 locale。
+    - **Type**: `Locales`
+    - **Default**: [`Project Configuration`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/configuration.md#middleware)
+
+  - `options.mode?: 'prefix-no-default' | 'prefix-all' | 'no-prefix' | 'search-params'`
+    - **Description**: 用于 locale 处理的 URL 路由模式。如果未提供，将使用项目配置中的已配置模式。
+    - **Type**: `'prefix-no-default' | 'prefix-all' | 'no-prefix' | 'search-params'`
+    - **Default**: [`Project Configuration`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/configuration.md#middleware)
+    - **Modes**:
+      - `prefix-no-default`: 默认 locale 无前缀，其他 locale 有前缀
+      - `prefix-all`: 所有 locale（包括默认 locale）都有前缀
+      - `no-prefix`: URL 中无 locale 前缀
+      - `search-params`: 使用查询参数表示 locale（例如，`?locale=fr`）
+
 ### 返回值
 
 - **类型**：`IConfigLocales<string>`
@@ -63,6 +107,20 @@ author: aymericzip
 
 ## 示例用法
 
+### 基本用法（使用项目配置）
+
+```typescript codeFormat={["typescript", "esm", "commonjs"]}
+import { getMultilingualUrls, Locales } from "intlayer";
+
+// 使用项目的配置来设置 locales、defaultLocale 和 mode
+getMultilingualUrls("/dashboard");
+// 输出（假设项目配置有 en、fr，mode 为 'prefix-no-default'）：
+// {
+//   en: "/dashboard",
+//   fr: "/fr/dashboard"
+// }
+```
+
 ### 相对 URL
 
 ```typescript codeFormat={["typescript", "esm", "commonjs"]}
@@ -97,6 +155,60 @@ getMultilingualUrls(
 
 ---
 
+### 不同的路由模式
+
+```typescript
+// prefix-no-default: 默认语言环境无前缀
+getMultilingualUrls("/dashboard", {
+  locales: [Locales.ENGLISH, Locales.FRENCH, Locales.SPANISH],
+  defaultLocale: Locales.ENGLISH,
+  mode: "prefix-no-default",
+});
+// Output: {
+//   en: "/dashboard",
+//   fr: "/fr/dashboard",
+//   es: "/es/dashboard"
+// }
+
+// prefix-all: 所有语言环境都有前缀
+getMultilingualUrls("/dashboard", {
+  locales: [Locales.ENGLISH, Locales.FRENCH, Locales.SPANISH],
+  defaultLocale: Locales.ENGLISH,
+  mode: "prefix-all",
+});
+// Output: {
+//   en: "/en/dashboard",
+//   fr: "/fr/dashboard",
+//   es: "/es/dashboard"
+// }
+
+// no-prefix: URL 中无语言环境前缀
+getMultilingualUrls("/dashboard", {
+  locales: [Locales.ENGLISH, Locales.FRENCH, Locales.SPANISH],
+  defaultLocale: Locales.ENGLISH,
+  mode: "no-prefix",
+});
+// Output: {
+//   en: "/dashboard",
+//   fr: "/dashboard",
+//   es: "/dashboard"
+// }
+
+// search-params: 语言环境作为查询参数
+getMultilingualUrls("/dashboard", {
+  locales: [Locales.ENGLISH, Locales.FRENCH, Locales.SPANISH],
+  defaultLocale: Locales.ENGLISH,
+  mode: "search-params",
+});
+// Output: {
+//   en: "/dashboard?locale=en",
+//   fr: "/dashboard?locale=fr",
+//   es: "/dashboard?locale=es"
+// }
+```
+
+---
+
 ## 边界情况
 
 - **无语言段：**

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

@@ -15,6 +15,9 @@ slugs:
   - next-intlayer
   - exports
 history:
+  - version: 10.0.0
+    date: 2026-06-23
+    changes: "添加 usePathname 实用程序"
   - version: 8.0.0
     date: 2026-01-21
     changes: "统一了所有导出的文档"
@@ -99,6 +102,7 @@ import "next-intlayer";
 | `useDictionaryAsync`   | 处理异步字典的 Hook。接受一个以 Promise 为值的字典映射，并为当前 locale 解析它。                             | -                                                                                                                       |
 | `useDictionaryDynamic` | 处理按键加载的动态字典的 Hook。内部使用 React Suspense 来处理加载状态。                                      | -                                                                                                                       |
 | `useLocale`            | 客户端 hook，用于获取当前 locale 并提供设置它的函数。为 Next.js App Router 增强，支持导航。                  | [useLocale](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/packages/react-intlayer/useLocale.md)         |
+| `usePathname`          | 返回当前路径名，去除了区域设置前缀以及去除了区域设置参数的查询参数。                                         | [usePathname](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/packages/next-intlayer/usePathname.md)      |
 | `useRewriteURL`        | 客户端 hook，用于管理 URL 重写。如果存在更优雅的本地化重写规则，会自动更新 URL。                             | [useRewriteURL](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/packages/next-intlayer/useRewriteURL.md)  |
 | `useLocalePageRouter`  | 用于 Next.js Page Router 的特定 locale 管理 hook。处理在 locale 更改时的重定向和页面重载。                   | -                                                                                                                       |
 | `useI18n`              | 提供翻译函数 `t()` 的 hook，用于通过键访问嵌套内容。模仿 i18next/next-intl 的模式。                          | [useI18n](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/packages/react-intlayer/useI18n.md)             |

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

@@ -0,0 +1,136 @@
+---
+createdAt: 2026-06-22
+updatedAt: 2026-06-22
+title: usePathname Hook 文档 | next-intlayer
+description: 了解如何使用 next-intlayer 包中的 usePathname 钩子
+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: "添加 usePathname 实用程序"
+  - version: 8.2.0
+    date: 2026-06-22
+    changes: "初始化历史记录"
+author: aymericzip
+---
+
+# Next.js 集成：`usePathname` 钩子（Hook）文档
+
+`usePathname` 钩子返回去除区域设置（locale）片段后的当前 Next.js 路径名（pathname）。这对于构建感知语言环境的导航非常有用——例如，判断哪个导航项处于活动状态——而无需手动剥离语言环境前缀。
+
+## 在 Next.js 中导入 `usePathname`
+
+```typescript
+import { usePathname } from "next-intlayer";
+```
+
+## 概述
+
+`usePathname` 包装了来自 `next/navigation` 的 Next.js 内置 `usePathname()`，附加了任何搜索参数（search params），并通过 `getPathWithoutLocale` 去除语言环境前缀。在每次客户端导航时，它都会触发重新渲染。该钩子仅在客户端组件中可用（需要 `"use client"`）。
+
+## 用法
+
+```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;
+```
+
+## 返回值
+
+| 类型     | 描述                                                             |
+| -------- | ---------------------------------------------------------------- |
+| `string` | 当前路径名，去除了区域设置前缀以及去除了区域设置参数的查询参数。 |
+
+## 行为
+
+- **区域设置剥离**：去除开头的语言环境片段（例如 `/zh/dashboard` → `/dashboard`）。
+- **查询参数剥离**：当使用基于搜索参数的路由模式时，也会去除 `?locale=...` 查询参数。
+- **响应式**：通过 Next.js App Router 的每次客户端导航都会自动更新。
+- **SSR 安全**：在首次渲染时返回服务端路径名，然后在客户端同步搜索参数。
+
+## 与 `useLocale` 的比较
+
+`next-intlayer` 的 `useLocale` 已经在其返回值中暴露了 `pathWithoutLocale`。当您仅需要路径而不需要切换语言环境的功能时，可以使用 `usePathname`。
+
+```tsx codeFormat={["typescript", "esm"]}
+// 当你需要语言环境状态和路径时：
+import { useLocale } from "next-intlayer";
+const { locale, pathWithoutLocale } = useLocale();
+
+// 当你只需要路径时：
+import { usePathname } from "next-intlayer";
+const pathname = usePathname();
+```
+
+## 示例
+
+```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: "仪表盘" },
+  { href: "/设置", label: "设置" },
+];
+
+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;
+```
+
+## 相关文档
+
+- [`useLocale`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/packages/next-intlayer/useLocale.md) — 当前语言环境 + 语言环境切换器（也暴露了 `pathWithoutLocale`）
+- [`getPathWithoutLocale`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/packages/intlayer/getPathWithoutLocale.md) — 该钩子使用的底层实用程序

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

@@ -14,6 +14,9 @@ slugs:
   - preact-intlayer
   - exports
 history:
+  - version: 10.0.0
+    date: 2026-06-23
+    changes: "添加 usePathname 实用工具"
   - version: 8.0.0
     date: 2026-01-21
     changes: "统一了所有导出的文档"
@@ -40,12 +43,13 @@ npm install preact-intlayer
 
 ### 钩子
 
-| 钩子            | 描述                                                            | 相关文档                                                                                        |
-| --------------- | --------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
-| `useIntlayer`   | 基于 `useDictionary`，但注入来自生成声明的优化版本的字典。      | -                                                                                               |
-| `useDictionary` | 处理类似字典的对象（key，content）。它处理 `t()` 翻译、枚举等。 | -                                                                                               |
-| `useLocale`     | 返回当前 locale 以及用于设置它的函数。                          | -                                                                                               |
-| `t`             | 根据当前 locale 选择内容。                                      | [翻译](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/dictionary/translation.md) |
+| 钩子            | 描述                                                                       | 相关文档                                                                                                             |
+| --------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
+| `useIntlayer`   | 基于 `useDictionary`，但注入来自生成声明的优化版本的字典。                 | -                                                                                                                    |
+| `useDictionary` | 处理类似字典的对象（key，content）。它处理 `t()` 翻译、枚举等。            | -                                                                                                                    |
+| `useLocale`     | 返回当前 locale 以及用于设置它的函数。                                     | -                                                                                                                    |
+| `usePathname`   | 钩子：返回移除 locale 语言段后的当前路径名。响应 `popstate` 的浏览器导航。 | [usePathname](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/packages/preact-intlayer/usePathname.md) |
+| `t`             | 根据当前 locale 选择内容。                                                 | [翻译](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/dictionary/translation.md)                      |
 
 ### 组件