# @enum-plus/plugin-i18next 中文文档

规范地址：https://npmcn.com/package/%40enum-plus/plugin-i18next/

版本：1\.0\.0
npm 元数据更新时间：2025-10-05T13:34:34.352Z
中文译文更新时间：2026-11-13T18:48:13.651Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40enum-plus/plugin-i18next
原文对照：https://npmcn.com/package/%40enum-plus/plugin-i18next/?lang=original
项目主页：https://github.com/shijistar/enum-plus
源码仓库：https://github.com/shijistar/enum-plus

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

- 包体积（解压后）：28.8 kB，22 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- peer 依赖：enum-plus ^3\.0\.0，i18next \>=8\.4\.0
- 首次发布：2025-10-05T13:34:33.712Z
- 最新版本发布：2025-10-05T13:34:34.016Z
- 近 30 天下载量：7236（2026-10-14 至 2026-11-12，npm 官方下载统计）
- 已发布版本数：1（近 12 个月 0 个）

## 中文简介

通过 i18next 支持 enums 国际化的 enum- plus 插件

## 安装

```sh
npm install @enum-plus/plugin-i18next
```

也可以使用：`pnpm add @enum-plus/plugin-i18next`、`yarn add @enum-plus/plugin-i18next`、`bun add @enum-plus/plugin-i18next`

## README

[English](https://npmcn.com/package/%40enum-plus/plugin-i18next/README.md) | [中文](https://npmcn.com/package/%40enum-plus/plugin-i18next/README.zh-CN.md) | [CHANGELOG](https://npmcn.com/package/%40enum-plus/plugin-i18next/CHANGELOG.md)

# enum-plus for Globalization with i18next

## 简介

`@enum-plus/plugin-i18next` 是 [enum-plus](https://github.com/shijistar/enum-plus) 的一个插件，自动集成 [i18next](https://www.i18next.com/) 实现枚举标签的国际化。它允许你在枚举定义中使用 i18next 的本地化键，并动态显示为当前语言的翻译文本。

> 该插件不支持切换语言后自动更新 UI，这需要结合前端框架（如 React、Vue 等）来实现。请考虑使用 [@enum-plus/plugin-react](https://github.com/shijistar/enum-plus/tree/main/packages/plugin-react) 或 [@enum-plus/plugin-vue](https://github.com/shijistar/enum-plus/tree/main/packages/plugin-vue) 插件。

## 安装

```bash
npm install @enum-plus/plugin-i18next
```

在应用程序的入口文件中，导入 `@enum-plus/plugin-i18next` 插件并安装：

```js
import i18nextPlugin from '@enum-plus/plugin-i18next';
import { Enum } from 'enum-plus';

Enum.install(i18nextPlugin);
```

## 插件选项

安装插件时，可以传入一个配置对象，用于设置插件的全局选项：

```ts
Enum.install(i18nextPlugin, {
  localize: {
    // 设置 i18next 实例，如果有必要，默认为全局的 i18next 实例
    instance: i18next,
    // 传递给 i18next.t 方法的默认选项
    tOptions: {
      // 设置命名空间
      ns: 'my-namespace',
      // 设置返回值的默认值
      defaultValue: '-',
      // 其它 i18next.t 方法支持的选项
      // 请参考 https://www.i18next.com/translation-function/essentials#overview-options
    },
  },
});
```

`tOptions` 还支持函数形式，以便动态生成选项，

```ts
// 使用函数形式动态生成 tOptions
Enum.install(i18nextPlugin, {
  localize: {
    tOptions: (key) => {
      if (key === 'week.sunday') {
        return { ns: 'my-namespace' };
      }
      return { ns: 'translation' }; // 默认命名空间
    },
  },
});
```

你甚至可以在 `tOptions` 中直接返回一个字符串，作为最终的翻译文本，以完全控制 `localize` 方法的行为。

```ts
Enum.install(i18nextPlugin, {
  localize: {
    tOptions: (key) => {
      if (key === 'week.sunday') {
        return '周日'; // 直接返回翻译文本
      }
      return instance.t(key); // 其它情况返回默认翻译
    },
  },
});
```

## 基本用法

可以通过在枚举定义中使用本地化键，来实现枚举标签的国际化。

```js
import { Enum } from 'enum-plus';

const WeekEnum = Enum(
  {
    Monday: { value: 1, label: 'week.monday' },
    Tuesday: { value: 2, label: 'week.tuesday' },
  },
  {
    name: 'weekDays.name', // 枚举类型名称，可选
  }
);

WeekEnum.label(1); // Monday
WeekEnum.name; // Week

i18next.changeLanguage('zh-CN');
WeekEnum.label(1); // 星期一
WeekEnum.name; // 星期
```

## 常见问题

### @enum-plus/plugin-i18next 是什么？

通过 i18next 支持 enums 国际化的 enum- plus 插件

### 如何安装 @enum-plus/plugin-i18next？

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

### @enum-plus/plugin-i18next 支持 TypeScript 吗？

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

### @enum-plus/plugin-i18next 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @enum-plus/plugin-i18next 可以商用吗？

@enum-plus/plugin-i18next 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @enum-plus/plugin-i18next 的下载量有多少？

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

### @enum-plus/plugin-i18next 还在维护吗？

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