# @ayub-begimkulov/i18n 中文文档

规范地址：https://npmcn.com/package/%40ayub-begimkulov/i18n/

版本：0\.2\.1
npm 元数据更新时间：2023-05-01T14:27:05.403Z
中文译文更新时间：2026-11-07T23:44:15.472Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40ayub-begimkulov/i18n
原文对照：https://npmcn.com/package/%40ayub-begimkulov/i18n/?lang=original
项目主页：https://github.com/Ayub-Begimkulov/i18n#readme
源码仓库：https://github.com/Ayub-Begimkulov/i18n

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

- 包体积（解压后）：28.6 kB，26 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- peer 依赖：react \>=16\.8\.0 \|\| 17\.x \|\| 18\.x
- 首次发布：2023-03-05T18:09:06.794Z
- 最新版本发布：2023-05-01T14:27:05.293Z
- 近 30 天下载量：1991（2026-10-08 至 2026-11-06，npm 官方下载统计）
- 已发布版本数：9（近 12 个月 0 个）

## 中文简介

小型和类型安全包可以创建多语言界面.

## 安装

```sh
npm install @ayub-begimkulov/i18n
```

也可以使用：`pnpm add @ayub-begimkulov/i18n`、`yarn add @ayub-begimkulov/i18n`、`bun add @ayub-begimkulov/i18n`

## README

# @ayub-begimkulov/i18n (英语)

小型和类型安全包可以创建多语言界面.

特征

-   基础i18n功能(内插,丰富文本,复数化).
-   腾讯全面支持. 这些类型是推断出来的,不需要用手写任何东西.
-   反应钩和组件.
-   能够同步(从服务器或懒惰地加载)加载翻译.
-   能够使用适合你的复数格式工作.

## 安装

```shell
npm i @ayub-begimkulov/i18n
```

## 使用量

### 基本实例

```ts
import { I18N, createPluralize } from "@ayub-begimkulov/i18n";
import en from "./keys/en.json";
import ru from "./keys/ru.json";

const pluralizeEn = createPluralize("en");
const pluralizeRu = createPluralize("ru");

const i18n = new I18N({
  defaultLang: "en",
  languages: {
    en: {
      keyset: en,
      pluralize: pluralizeEn,
    },
    ru: {
      keyset: ru,
      pluralize: pluralizeRu,
    },
  },
});

i18n.get("greeting"); // Hello
```

### 用反应

```ts
// i18n.ts
import {
  I18N,
  createPluralize,
  useTranslate as useTranslateBase,
  useI18n as useI18nBase,
} from "@ayub-begimkulov/i18n";
import en from "./keys/en.json";
import ru from "./keys/ru.json";

const pluralizeEn = createPluralize("en");
const pluralizeRu = createPluralize("ru");

const i18n = new I18N({
  defaultLang: "en",
  languages: {
    en: {
      keyset: en,
      pluralize: pluralizeEn,
    },
    ru: {
      keyset: ru,
      pluralize: pluralizeRu,
    },
  },
});

export const useTranslate = useTranslateBase<typeof i18n>;
export const useI18n = useI18nBase<typeof i18n>;

// index.tsx
import { I18NProvider } from "@ayub-begimkulov/i18n";
import { i18n } from "./i18n";

// ...

root.render(
  <I18NProvider i18n={i18n}>
    <App />
  </I18NProvider>
);

// component.ts
import { useTranslate } from "./i18n";

const Component = () => {
  const translate = useTranslate();

  return <div>{translate("some_key")}</div>;
};
```

## 食谱

开始

## 参考文献

### `I18N`

负责加载/存储翻译和更新语言的类别。 所有反应功能杠杆 `I18N` API 在需要时更新组件 .

示例

```ts
import { I18N, createPluralize } from "@ayub-begimkulov/i18n";
import en from "./keys/en.json";
import ru from "./keys/ru.json";

const pluralizeEn = createPluralize("en");
const pluralizeRu = createPluralize("ru");

const i18n = new I18N({
  defaultLang: "en",
  languages: {
    en: {
      keyset: en,
      pluralize: pluralizeEn,
    },
    ru: {
      keyset: ru,
      pluralize: pluralizeRu,
    },
  },
});

i18n.get("greeting"); // 'Hello'
```

### `useI18n`

一个带有i18n的属性/方法返回对象的钩子. 当语言发生变化时更新组件.

示例

```tsx
const allLanguages = ["en", "ru", "ar"];

const Component = () => {
  const { lang, setLang } = useI18n();

  return (
    <>
      <div>{lang}</div>
      {allLanguages.map((lang) => (
        <div onClick={() => setLang(lang)}>Select {lang}</div>
      ))}
    </>
  );
};
```

### `useTranslate`

返回翻译函数的钩子 。 使用此钩的组件会随时更新语言变化.

示例

```tsx
import { useTranslate } from "@ayub-begimkulov/i18n";

const Component = () => {
  const t = useTranslate();

  return <div>{t("welcome")}</div>;
};
```

### `createPluralize`

为给定的地块创建复数函数,以返回特定项目数的复数格式。 积分 [`Intl.PluralRules`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/PluralRules) 在引擎盖下.

示例

```ts
import { createPluralize } from "@ayub-begimkulov/i18n";

const pluralizeEn = createPluralize("en");

pluralizeEn(1); // 'one'
pluralizeEn(0); // 'other'
```

### `I18NProvider`

环绕 React 上下文提供者的包装器 。 用来分享 `I18N` 实例。 大部分用于库钩内部(`useI18n`编号 :`useTranslate`) (中文(简体) ).

示例

```tsx
import { I18NProvider } from '@ayub-begimkulov/i18n';
import { App } from './App';
import { i18n } form './i18n';

root.render(
  <I18NProvider i18n={i18n}>
    <App />
  </I18NProvider>
)
```

### `TaggedText`

允许在翻译中使用 React 组件的组件.

示例

```tsx
import { TaggedText, useTranslate } from "@ayub-begimkulov/i18n";

export const Component = () => {
  const t = useTranslate();

  console.log(t("key")); // "<1>Important!</1> Check out <2>the project documentation</2> before using this library"

  return (
    <div>
      <TaggedText
        text={t("key")}
        tags={{
          1: (text) => <strong>{text}</strong>,
          2: (text) => <a>{text}</a>,
        }}
      />
    </div>
  );
};
```

## 许可证

麻省理工学院.

## 常见问题

### @ayub-begimkulov/i18n 是什么？

小型和类型安全包可以创建多语言界面\.

### 如何安装 @ayub-begimkulov/i18n？

在项目目录运行 npm install @ayub-begimkulov/i18n，或使用 pnpm add / yarn add / bun add。

### @ayub-begimkulov/i18n 支持 TypeScript 吗？

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

### @ayub-begimkulov/i18n 支持 ESM 还是 CommonJS？

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

### @ayub-begimkulov/i18n 可以商用吗？

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

### @ayub-begimkulov/i18n 的下载量有多少？

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

### @ayub-begimkulov/i18n 还在维护吗？

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