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

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

@@ -14,6 +14,9 @@ slugs:
   - solid-intlayer
   - exports
 history:
+  - version: 10.0.0
+    date: 2026-06-23
+    changes: "添加 usePathname 实用程序"
   - version: 8.0.0
     date: 2026-01-21
     changes: "统一了所有导出的文档"
@@ -52,17 +55,18 @@ import "solid-intlayer";
 import "solid-intlayer";
 ```
 
-| 钩子                   | 描述                                                                       | 相关文档                                                                                                                |
-| ---------------------- | -------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
-| `useIntlayer`          | 基于 `useDictionary`，但注入了从生成的声明中优化后的字典版本。             | [useIntlayer](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/packages/solid-intlayer/useIntlayer.md)     |
-| `useDictionary`        | 处理类似字典（键，内容）的对象。它处理 `t()` 翻译、枚举等。                | -                                                                                                                       |
-| `useDictionaryAsync`   | 与 `useDictionary` 相同，但处理异步字典。                                  | -                                                                                                                       |
-| `useDictionaryDynamic` | 与 `useDictionary` 相同，但处理动态字典。                                  | -                                                                                                                       |
-| `useLocale`            | 返回当前 locale 和一个用于设置它的函数。                                   | [useLocale](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/packages/solid-intlayer/useLocale.md)         |
-| `useRewriteURL`        | 客户端 hook，用于管理 URL 重写。如果存在本地化的重写规则，会自动更新 URL。 | [useRewriteURL](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/packages/solid-intlayer/useRewriteURL.md) |
-| `useIntl`              | 返回当前 locale 的 Intl 对象。                                             | -                                                                                                                       |
-| `useLoadDynamic`       | 用于加载动态字典的 Hook。                                                  | -                                                                                                                       |
-| `t`                    | 根据当前 locale 选择内容。                                                 | [translation](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/dictionary/translation.md)                  |
+| 钩子                   | 描述                                                                                        | 相关文档                                                                                                                |
+| ---------------------- | ------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
+| `useIntlayer`          | 基于 `useDictionary`，但注入了从生成的声明中优化后的字典版本。                              | [useIntlayer](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/packages/solid-intlayer/useIntlayer.md)     |
+| `useDictionary`        | 处理类似字典（键，内容）的对象。它处理 `t()` 翻译、枚举等。                                 | -                                                                                                                       |
+| `useDictionaryAsync`   | 与 `useDictionary` 相同，但处理异步字典。                                                   | -                                                                                                                       |
+| `useDictionaryDynamic` | 与 `useDictionary` 相同，但处理动态字典。                                                   | -                                                                                                                       |
+| `useLocale`            | 返回当前 locale 和一个用于设置它的函数。                                                    | [useLocale](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/packages/solid-intlayer/useLocale.md)         |
+| `usePathname`          | 返回移除了 locale 分段的当前路径 (pathname)，作为一个 `Accessor<string>`。响应 `popstate`。 | [usePathname](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/packages/solid-intlayer/usePathname.md)     |
+| `useRewriteURL`        | 客户端 hook，用于管理 URL 重写。如果存在本地化的重写规则，会自动更新 URL。                  | [useRewriteURL](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/packages/solid-intlayer/useRewriteURL.md) |
+| `useIntl`              | 返回当前 locale 的 Intl 对象。                                                              | -                                                                                                                       |
+| `useLoadDynamic`       | 用于加载动态字典的 Hook。                                                                   | -                                                                                                                       |
+| `t`                    | 根据当前 locale 选择内容。                                                                  | [translation](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/dictionary/translation.md)                  |
 
 ### 组件
 

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

@@ -0,0 +1,119 @@
+---
+createdAt: 2026-06-22
+updatedAt: 2026-06-22
+title: usePathname Hook 文档 | solid-intlayer
+description: 了解如何使用 solid-intlayer 包中的 usePathname hook
+keywords:
+  - usePathname
+  - pathname
+  - locale
+  - Intlayer
+  - 国际化
+  - 文档
+  - Solid
+  - Solid.js
+  - JavaScript
+slugs:
+  - doc
+  - packages
+  - solid-intlayer
+  - usePathname
+history:
+  - version: 10.0.0
+    date: 2026-06-23
+    changes: "添加 usePathname 实用程序"
+  - version: 8.2.0
+    date: 2026-06-22
+    changes: "初始化历史记录"
+author: aymericzip
+---
+
+# Solid 集成: `usePathname` Hook 文档
+
+`usePathname` Hook 返回当前浏览器路径 (pathname)，并去除了语言区域 (locale) 片段，类型为 Solid 的 `Accessor<string>`。它在构建包含本地化的导航栏时非常有用（例如，确定哪个导航项处于活动状态），无需手动删除 locale 前缀。
+
+## 在 Solid 中导入 `usePathname`
+
+```typescript
+import { usePathname } from "solid-intlayer";
+```
+
+## 概览
+
+`usePathname` 创建一个从 `window.location.pathname` 初始化的响应式信号 (reactive signal)，通过 `getPathWithoutLocale` 剥离 locale 前缀，并在浏览器触发 `popstate` 事件（后退/前进导航）时更新信号。事件监听器通过 `onCleanup` 自动清理。
+
+## 用法
+
+```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;
+```
+
+## 返回值
+
+| 类型               | 描述                                                                           |
+| ------------------ | ------------------------------------------------------------------------------ |
+| `Accessor<string>` | Solid Accessor（响应式 getter），返回不包含 locale 前缀的当前路径 (pathname)。 |
+
+## 行为
+
+- **剥离 Locale**: 移除路径首部的 locale 片段（例如：`/zh/dashboard` → `/dashboard`）。
+- **响应式**: 在触发 `popstate` 事件（浏览器后退 / 前进导航）时自动更新。
+- **SSR 安全**: 当 `window` 不可用时返回 `""`。
+- **清理**: `popstate` 监听器会通过 Solid 的 `onCleanup` 自动移除。
+
+## 示例
+
+```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: "仪表盘" },
+  { href: "/settings", label: "设置" },
+];
+
+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;
+```
+
+## 相关文档
+
+- [`useLocale`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/packages/solid-intlayer/useLocale.md) — 当前语言区域 + 切换语言区域
+- [`getPathWithoutLocale`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/packages/intlayer/getPathWithoutLocale.md) — 此 Hook 底层使用的工具函数

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

@@ -14,6 +14,9 @@ slugs:
   - svelte-intlayer
   - exports
 history:
+  - version: 10.0.0
+    date: 2026-06-23
+    changes: "添加 usePathname 实用程序"
   - version: 8.0.0
     date: 2026-01-21
     changes: "统一了所有导出的文档"
@@ -64,15 +67,16 @@ Import:
 import "svelte-intlayer";
 ```
 
-| Function               | Description                                                               | Related Doc                                                                                                              |
-| ---------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ |
-| `useIntlayer`          | 基于 `useDictionary`，但注入从生成的声明中得到的优化版本的字典。          | -                                                                                                                        |
-| `useDictionary`        | 处理类似字典的对象（键、内容）。它处理 `t()` 翻译、枚举等。               | -                                                                                                                        |
-| `useDictionaryAsync`   | 与 `useDictionary` 相同，但处理异步字典。                                 | -                                                                                                                        |
-| `useDictionaryDynamic` | 与 `useDictionary` 相同，但处理动态字典。                                 | -                                                                                                                        |
-| `useLocale`            | 返回当前 locale 以及用于设置它的函数。                                    | -                                                                                                                        |
-| `useRewriteURL`        | 用于客户端管理 URL 重写的函数。如果存在本地化的重写规则，会自动更新 URL。 | [useRewriteURL](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/packages/svelte-intlayer/useRewriteURL.md) |
-| `useIntl`              | 返回当前 locale 的 Intl 对象。                                            | -                                                                                                                        |
+| Function               | Description                                                                                                   | Related Doc                                                                                                              |
+| ---------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ |
+| `useIntlayer`          | 基于 `useDictionary`，但注入从生成的声明中得到的优化版本的字典。                                              | -                                                                                                                        |
+| `useDictionary`        | 处理类似字典的对象（键、内容）。它处理 `t()` 翻译、枚举等。                                                   | -                                                                                                                        |
+| `useDictionaryAsync`   | 与 `useDictionary` 相同，但处理异步字典。                                                                     | -                                                                                                                        |
+| `useDictionaryDynamic` | 与 `useDictionary` 相同，但处理动态字典。                                                                     | -                                                                                                                        |
+| `useLocale`            | 返回当前 locale 以及用于设置它的函数。                                                                        | -                                                                                                                        |
+| `usePathname`          | 返回当前路径名（pathname）作为 `Readable<string>` store，其中 locale 细分已被移除。对 `popstate` 具有响应性。 | [usePathname](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/packages/svelte-intlayer/usePathname.md)     |
+| `useRewriteURL`        | 用于客户端管理 URL 重写的函数。如果存在本地化的重写规则，会自动更新 URL。                                     | [useRewriteURL](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/packages/svelte-intlayer/useRewriteURL.md) |
+| `useIntl`              | 返回当前 locale 的 Intl 对象。                                                                                | -                                                                                                                        |
 
 ### Markdown
 

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

@@ -0,0 +1,103 @@
+---
+createdAt: 2026-06-22
+updatedAt: 2026-06-22
+title: usePathname 函数文档 | svelte-intlayer
+description: 了解如何使用 svelte-intlayer 包中的 usePathname 函数
+keywords:
+  - usePathname
+  - pathname
+  - locale
+  - Intlayer
+  - 国际化
+  - 文档
+  - Svelte
+  - JavaScript
+slugs:
+  - doc
+  - packages
+  - svelte-intlayer
+  - usePathname
+history:
+  - version: 10.0.0
+    date: 2026-06-23
+    changes: "添加 usePathname 实用程序"
+  - version: 8.2.0
+    date: 2026-06-22
+    changes: "初始化历史记录"
+author: aymericzip
+---
+
+# Svelte 集成：`usePathname` 文档
+
+`usePathname` 函数以 Svelte 的 `Readable<string>` store 形式返回去除了 locale 段的当前浏览器路径名（pathname）。这对于构建支持 locale 的导航非常有用——例如，判断哪个导航项是激活状态的——而无需手动去除 locale 前缀。
+
+## 在 Svelte 中导入 `usePathname`
+
+```typescript
+import { usePathname } from "svelte-intlayer";
+```
+
+## 概述
+
+`usePathname` 创建一个 Svelte readable store，它读取 `window.location.pathname`，通过 `getPathWithoutLocale` 去除 locale 前缀，并在浏览器触发 `popstate` 事件（后退/前进导航）时发出新值。在组件中使用 `$` 语法来订阅。
+
+## 用法
+
+```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>
+```
+
+## 返回值
+
+| 类型               | 描述                                                                   |
+| ------------------ | ---------------------------------------------------------------------- |
+| `Readable<string>` | 包含不带 locale 前缀的当前路径名（pathname）的 Svelte readable store。 |
+
+## 行为
+
+- **去除 Locale**：移除开头的 locale 段（例如 `/zh/dashboard` → `/dashboard`）。
+- **响应式**：在每次 `popstate` 事件（浏览器的后退 / 前进导航）触发时发出新值。
+- **SSR 安全**：在 `window` 不可用时返回 `""`。
+- **清理（Cleanup）**：当最后一个订阅者取消订阅时，会自动移除 `popstate` 监听器。
+
+## 示例
+
+```svelte fileName="src/components/Sidebar.svelte"
+<script lang="ts">
+  import { usePathname } from "svelte-intlayer";
+
+  const links = [
+    { href: "/dashboard", label: "仪表盘" },
+    { href: "/settings", label: "设置" },
+  ];
+
+  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>
+```
+
+## 相关阅读
+
+- [`useLocale`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/packages/svelte-intlayer/useLocale.md) — 当前 locale + locale 切换器
+- [`getPathWithoutLocale`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/packages/intlayer/getPathWithoutLocale.md) — 该 hook 所使用的底层实用程序

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

@@ -14,6 +14,9 @@ slugs:
   - vue-intlayer
   - exports
 history:
+  - version: 10.0.0
+    date: 2026-06-23
+    changes: "添加 usePathname 实用程序"
   - version: 8.0.0
     date: 2026-01-21
     changes: "统一了所有导出的文档"
@@ -52,16 +55,17 @@ import "vue-intlayer";
 import "vue-intlayer";
 ```
 
-| 组合函数               | 说明                                                                             | 相关文档                                                                                                              |
-| ---------------------- | -------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- |
-| `useIntlayer`          | 基于 `useDictionary`，但注入来自生成声明的经过优化的字典版本。                   | -                                                                                                                     |
-| `useDictionary`        | 处理类似字典的对象（key、content）。它会处理 `t()` 翻译、枚举等。                | -                                                                                                                     |
-| `useDictionaryAsync`   | 与 `useDictionary` 相同，但处理异步字典。                                        | -                                                                                                                     |
-| `useDictionaryDynamic` | 与 `useDictionary` 相同，但处理动态字典。                                        | -                                                                                                                     |
-| `useLocale`            | 返回当前 locale 以及用于设置它的函数。                                           | -                                                                                                                     |
-| `useRewriteURL`        | 客户端 composable，用于管理 URL 重写。如果存在本地化的重写规则，会自动更新 URL。 | [useRewriteURL](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/packages/vue-intlayer/useRewriteURL.md) |
-| `useIntl`              | 返回当前 locale 的 Intl 对象。                                                   | -                                                                                                                     |
-| `useLoadDynamic`       | 用于加载动态字典的 composable。                                                  | -                                                                                                                     |
+| 组合函数               | 说明                                                                                                   | 相关文档                                                                                                              |
+| ---------------------- | ------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------- |
+| `useIntlayer`          | 基于 `useDictionary`，但注入来自生成声明的经过优化的字典版本。                                         | -                                                                                                                     |
+| `useDictionary`        | 处理类似字典的对象（key、content）。它会处理 `t()` 翻译、枚举等。                                      | -                                                                                                                     |
+| `useDictionaryAsync`   | 与 `useDictionary` 相同，但处理异步字典。                                                              | -                                                                                                                     |
+| `useDictionaryDynamic` | 与 `useDictionary` 相同，但处理动态字典。                                                              | -                                                                                                                     |
+| `useLocale`            | 返回当前 locale 以及用于设置它的函数。                                                                 | -                                                                                                                     |
+| `usePathname`          | 返回当前路径名（pathname）作为 `ComputedRef<string>`，并已移除 locale 片段。对 `popstate` 具有响应式。 | [usePathname](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/packages/vue-intlayer/usePathname.md)     |
+| `useRewriteURL`        | 客户端 composable，用于管理 URL 重写。如果存在本地化的重写规则，会自动更新 URL。                       | [useRewriteURL](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/packages/vue-intlayer/useRewriteURL.md) |
+| `useIntl`              | 返回当前 locale 的 Intl 对象。                                                                         | -                                                                                                                     |
+| `useLoadDynamic`       | 用于加载动态字典的 composable。                                                                        | -                                                                                                                     |
 
 ### 函数
 

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

@@ -0,0 +1,109 @@
+---
+createdAt: 2026-06-22
+updatedAt: 2026-06-22
+title: usePathname 函数文档 | vue-intlayer
+description: 了解如何使用 vue-intlayer 包中的 usePathname 函数
+keywords:
+  - usePathname
+  - pathname
+  - locale
+  - Intlayer
+  - 国际化 (Internationalization)
+  - 文档 (Documentation)
+  - Vue
+  - JavaScript
+slugs:
+  - doc
+  - packages
+  - vue-intlayer
+  - usePathname
+history:
+  - version: 10.0.0
+    date: 2026-06-23
+    changes: "添加 usePathname 实用程序"
+  - version: 8.2.0
+    date: 2026-06-22
+    changes: "初始化历史记录"
+author: aymericzip
+---
+
+# Vue 集成：`usePathname` 文档
+
+`usePathname` 函数返回当前浏览器的路径名（pathname），并以 Vue `ComputedRef<string>` 的形式提供移除了 locale 片段后的路径名。这对于构建可感知 locale 的导航非常有用——例如，确定哪个导航项处于激活状态——而无需手动移除 locale 前缀。
+
+## 在 Vue 中导入 `usePathname`
+
+```typescript
+import { usePathname } from "vue-intlayer";
+```
+
+## 概览
+
+`usePathname` 创建一个 Vue 计算引用 (computed ref)，它读取 `window.location.pathname`，通过 `getPathWithoutLocale` 移除 locale 前缀，并且每当浏览器触发 `popstate` 事件（后退/前进导航）时自动更新其值。该值可以直接在你的 Vue 模板或 setup 函数中使用。
+
+## 用法
+
+```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>
+```
+
+## 返回值
+
+| 类型                  | 描述                                                             |
+| --------------------- | ---------------------------------------------------------------- |
+| `ComputedRef<string>` | Vue Computed Ref，包含不带 locale 前缀的当前路径名（pathname）。 |
+
+## 行为
+
+- **Locale 剥离 (Locale stripping)**：移除路径开头的 locale 片段（例如：`/zh/dashboard` → `/dashboard`）。
+- **响应式 (Reactive)**：在每次 `popstate` 事件（浏览器后退 / 前进导航）时更新值。
+- **SSR 安全 (SSR-safe)**：当 `window` 不可用时返回 `""`。
+- **清理 (Cleanup)**：`popstate` 监听器在初始化时全局添加，由于 Vue 对生命周期的管理，通常不需要在每个组件中手动进行清理。
+
+## 示例
+
+```vue fileName="src/components/Sidebar.vue"
+<script setup lang="ts">
+import { usePathname } from "vue-intlayer";
+
+const links = [
+  { href: "/dashboard", label: "仪表盘" },
+  { href: "/settings", label: "设置" },
+];
+
+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>
+```
+
+## 相关内容
+
+- [`useLocale`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/packages/vue-intlayer/useLocale.md) — 当前 locale 及其切换器
+- [`getPathWithoutLocale`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/packages/intlayer/getPathWithoutLocale.md) — 此 hook 所使用的底层实用函数