# @byline/i18n 中文文档

规范地址：https://npmcn.com/package/%40byline/i18n/

版本：6\.13\.0
npm 元数据更新时间：2026-11-04T13:17:31.420Z
中文译文更新时间：2026-11-08T21:29:26.333Z
软件包许可：MPL-2\.0

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40byline/i18n
原文对照：https://npmcn.com/package/%40byline/i18n/?lang=original
项目主页：https://github.com/Byline-CMS/bylinecms.dev
源码仓库：https://github.com/Byline-CMS/bylinecms.dev

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：2 MB，60 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=22\.22\.2
- 运行依赖：5 个
- peer 依赖：react ^19\.0\.0，react-dom ^19\.0\.0
- 首次发布：2026-05-28T13:01:06.360Z
- 最新版本发布：2026-11-04T13:17:31.235Z
- 近 30 天下载量：2385（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：107（近 12 个月 107 个）

## 中文简介

Byline CMS 管理员界面 i18n — 翻译注册,ICU formatter, React 提供者,语言切换器

## 安装

```sh
npm install @byline/i18n
```

也可以使用：`pnpm add @byline/i18n`、`yarn add @byline/i18n`、`bun add @byline/i18n`

## README

# @byline/i18n (英语)

Byline CMS 的管理界面 i18n 原始文件 — 一个翻译注册, 一个 ICU Message Format formatter, 一个 React 提供者 + `useTranslation()` 钩子,自成一体 `<LanguageMenu>`,和纯本地分辨率级联.

这个包是 _接口_ i18n 的轴(管理员UI的语句)。 这个 _内容_ 轴(文档以何种语言发布)是一个单独的关切问题,由 `i18n.content` 关于现有 `BaseConfig`两者是有意独立的.

完整的设计——注册模式、插件可扩展性表面、每个用户的持久性、未来阶段——见 [`docs/08-internationalization/index.md`](https://npmcn.com/package/docs/08-internationalization/index.md) 在雷波根.

## 安装

```sh
pnpm add @byline/i18n
```

软件包将每个官方的 Byline 管理员翻译作为 JSON 文件捆绑在下面 `src/admin/`今天是英语`en.json`)和法语(`fr.json`; 添加新地块是单文件的PR. 这个 `adminTranslations({ locales })` 工厂只读取所要求的代码,并组装一个捆绑.

## 三个入境点

```ts
import { mergeTranslations, createFormatter, resolveAdminLocale } from '@byline/i18n'
import { I18nProvider, useTranslation, LanguageMenu } from '@byline/i18n/react'
import { adminTranslations, en } from '@byline/i18n/admin'
```

-   **根号** ——类型,事由,合并帮助器,地产级联. react-free; 服务器上的安全性 .
-   **`/react`** ——提供方,钩子,开关. 按设计单管( 边接 Vite) `optimizeDeps` 之前咬过这个代码库的背景识别陷阱 .
-   **`/admin`** - 捆绑的 `byline-admin` 名称空间和 `adminTranslations(...)` 工厂.

## 最小接线

```ts
// apps/your-app/byline/admin.config.ts
import { defineAdminConfig } from '@byline/core'
import { adminTranslations } from '@byline/i18n/admin'

defineAdminConfig({
  i18n: {
    admin: {
      defaultLocale: 'en',
      locales: ['en'],
    },
    // … content locales as before
    translations: adminTranslations({ locales: ['en'] }),
  },
  // … the rest of your admin config
})
```

## 添加第二个地块

```ts
import { adminTranslations } from '@byline/i18n/admin'

i18n: {
  admin: { defaultLocale: 'en', locales: ['en', 'fr'] },
  translations: adminTranslations({ locales: ['en', 'fr'] }),
}
```

捆绑的地块集导出为 `bundledLocales` 对于想要从可用内容中获取本地地址列表的主机:

```ts
import { adminTranslations, bundledLocales } from '@byline/i18n/admin'

i18n: {
  admin: { defaultLocale: 'en', locales: [...bundledLocales] },
  translations: adminTranslations({ locales: bundledLocales }),
}
```

`adminTranslations({ locales: ['xx'] })` 当请求的代码不在时, 在配置时抛出 `bundledLocales`。要提供新语言,请将 JSON 文件与 `src/admin/en.json` 并将其添加到捆绑地图中.

## 插件贡献

一个插件(richtext扩展名,自定义字段,AI工具,.)将自己的JSON文件装入自己的包并曝光工厂匹配 `adminTranslations`形状——取出 `{ locales }`,返回 a `TranslationBundle` 用于插件本身的命名空间。 主机将它们合并到 `defineAdminConfig`数字 :

```ts
import { mergeTranslations } from '@byline/i18n'
import { adminTranslations } from '@byline/i18n/admin'
import { aiTranslations } from '@byline/ai/i18n'

i18n: {
  admin: { defaultLocale: 'en', locales: ['en', 'fr'] },
  translations: mergeTranslations(
    adminTranslations({ locales: ['en', 'fr'] }),
    aiTranslations({ locales: ['en', 'fr'] }),
  ),
}
```

载运主机未启用的地块的插件是无害的 —— 插件的厂家仅仅不返回代码, 合并后产生一个空条目, 启动验证器门对面 `i18n.admin.locales` 无论如何.

`mergeTranslations` 是关联性+决定性; 后期源在 `(locale, namespace, key)` 谷物和一 `MergeOptions.onCollision` 用于在开发过程中的表面冲突.

公约:

-   `byline-admin` ——内置管理员外壳命名空间.
-   `byline-<package>` - 每一个旁线包件(`byline-richtext-lexical`, (中文(简体) ), `byline-ai`(中文(简体) ).
-   `<org>-<plugin>` ——第三方插件(软件包名称为 `@` 财务报告和审定财务报表 `/` 平调.

## 使用 `useTranslation` 组件

```tsx
import { useTranslation } from '@byline/i18n/react'

export function PublishButton() {
  const { t } = useTranslation('byline-admin')
  return <button>{t('common.actions.publish')}</button>
}
```

`t(key, values)` 总是返回字符串。 ICU MessageFormat语法在数值上工作——复数,日期,数字,选择:

```ts
t('list.unread', { count: 3 })             // "3 unread"
t('doc.publishedOn', { date: new Date() }) // "Published on May 28, 2026"
```

缺少的密钥掉入 `active locale → default locale → raw key`一发 `console.warn` 每个缺失 `(locale, namespace, key)` 三重火灾在德夫,所以差距是显而易见的.

## 服务器侧翻译

`createFormatter` 纯和无反作用,所以加载器和服务器函数直接使用:

```ts
import { createFormatter } from '@byline/i18n'

const { t } = createFormatter({
  bundle,                  // the merged TranslationBundle
  activeLocale: 'fr',
  defaultLocale: 'en',
}).bind(null, 'byline-admin')

return { subject: t('email.invite.subject') }
```

在TanStack Start主机中, `resolveServerTranslator(namespace)` (以千美元计) `@byline/host-tanstack-start`)以请求解决的地块来包装.

## 地方分辨率级联

`resolveAdminLocale` 同样的纯级联运行在客户端和服务器上 所以SSR和水合产生相同的答案:

```ts
import { resolveAdminLocale } from '@byline/i18n'

const activeLocale = resolveAdminLocale({
  locales: ['en', 'fr'],
  defaultLocale: 'en',
  preferred: actor?.admin_user?.preferred_locale,
  cookie: getCookie('byline_admin_lng'),
  acceptLanguage: getRequestHeader('accept-language'),
})
```

分级顺序 : `preferred → cookie → acceptLanguage → defaultLocale`。每个信号对允许的 `locales` 设置,所以一个 stale cookie 指向一个被移除的地盘 干净地掉下来.

## 这是什么 _没有_ 这里( yet)

-   **懒惰地装入.** 当地人现在急切地捆绑着 超过 ~5 个本地位, 切换到 Async 加载器可赚取其复杂度; 见 阶段 3 in [`docs/08-internationalization/index.md`](https://npmcn.com/package/docs/08-internationalization/index.md)。 。 。 .
-   **撰写时间元数据** (按键描述,复数提示,去色标记). 第4阶段.
-   **RTL 管理员布局.** 第5阶段:首先需要社区翻译的RTL locale来显示CSS破损的真实清单.
-   **内置翻译编辑** (中文(简体) ). 蓄意出道.

## 许可证

MPL -2.0 (英语).

## 常见问题

### @byline/i18n 是什么？

Byline CMS 管理员界面 i18n — 翻译注册,ICU formatter, React 提供者,语言切换器

### 如何安装 @byline/i18n？

在项目目录运行 npm install @byline/i18n，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：react（^19\.0\.0）、react-dom（^19\.0\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @byline/i18n 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @byline/i18n 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @byline/i18n 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=22\.22\.2。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @byline/i18n 可以商用吗？

@byline/i18n 使用 MPL-2\.0 许可。弱 Copyleft：可以商用，也可以和闭源代码一起使用；但如果分发时修改了 MPL 授权的文件，这些文件的修改需以 MPL 开源。以上为概括，不构成法律意见，请以许可原文为准。

### @byline/i18n 的下载量有多少？

根据 npm 官方下载统计，@byline/i18n 在 2026/10/09 – 2026/11/07 这 30 天内被下载 2,385 次，日均约 80 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @byline/i18n 还在维护吗？

最新版本 6\.13\.0 发布于 2026/11/04（4 天前）；至今共发布 107 个版本，其中过去 12 个月发布了 107 个；首次发布于 2026/05/28。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。