i18n

i18n 工具

用法

i18n 默认提供 FileSyncAdapter、ObjectAdapter 两个适配器，适用的场景分别为:

• FileSyncAdapter: locales 信息保存在文件中, 该适配器只适用于 Nodejs 平台
• ObjectAdapter: locales 信息保存在对象中, 该适配器适用于 Web 平台、Nodejs 平台

Nodejs

• 安装

  npm install @picgo/i18n -S

• 使用

  1import { I18n, FileSyncAdapter, ObjectAdapter } from '@picgo/i18n';
  2
  3// use FileSyncAdapter
  4const fileSyncAdapter = new FileSyncAdapter({
  5  localesBaseDir: path.resolve(__dirname, './locales'), // locales文件目录
  6});
  7
  8const i18n = new I18n({
  9  adapter: fileSyncAdapter,
  10  defaultLanguage: 'zh',
  11});
  12
  13// use ObjectAdapter
  14const objectAdapter = new ObjectAdapter({
  15  zh: {
  16    user: {
  17      name: 'PicGo',
  18      country: '中国',
  19    },
  20    report: {
  21      singular: ' ${cnt}个报告',
  22      plural: '${cnt}个报告',
  23    },
  24  },
  25  en: {
  26    user: {
  27      name: 'PicGo',
  28      country: 'China',
  29    },
  30    report: {
  31      singular: 'only ${cnt} report',
  32      plural: '${cnt} reports',
  33    },
  34  },
  35});
  36const i18n = new I18n({
  37  adapter: objectAdapter,
  38  defaultLanguage: 'zh',
  39});

Web

• 引入

  1<script src="https://cdn.jsdelivr.net/npm/@picgo/i18n/dist/i18n_umd.js"></script>

• 使用

  1const { ObjectAdapter, I18n } = PicGo_I18n;
  2// use ObjectAdapter
  3const objectAdapter = new ObjectAdapter({
  4  zh: {
  5    user: {
  6      name: 'PicGo',
  7      country: '中国',
  8    },
  9    report: {
  10      singular: ' ${cnt}个报告',
  11      plural: '${cnt}个报告',
  12    },
  13  },
  14  en: {
  15    user: {
  16      name: 'PicGo',
  17      country: 'China',
  18    },
  19    report: {
  20      singular: 'only ${cnt} report',
  21      plural: '${cnt} reports',
  22    },
  23  },
  24});
  25const i18n = new I18n({
  26  adapter: objectAdapter,
  27  defaultLanguage: 'zh',
  28});

自定义 Adapter

1import { BaseAdapter } from 'i18n';
2class CustomAdapter extends BaseAdapter {
3  getLocale(language) {}
4}

API

I18n

• 构造函数 I18n

  • 参数: options

    1{
    2  "adater": BaseAdapter, // 适配器
    3  "defaultLanguage": string // 默认语言
    4}

  • 返回值: I18n 实例

• i18n.setLanguage

  • 参数: language, 语言类型
  • 无返回值

• i18n.getLauguage

  • 无参数
  • 返回当前语言类型

• i18n.translate

  • 参数 phrase, args
  • 返回翻译后文本

  1// en.json
  2{
  3  "report": {
  4    "singular": "only ${cnt} report",
  5    "plural": "${cnt} reports"
  6  }
  7}

  1i18n.translate('report.singular', { cnt: 1 }); // only 1 report

FileSyncAdapter

• 构造函数 FileSyncAdapter

  • 参数: options

    1{
    2  "localesBaseDir": string, // locales 文件所在路径，绝对路径
    3  "localeFileName": { "language": 对应的locales文件名 } // localeFileName存储语言类型到locales文件的映射，该项可选，当不传入时，将自动扫描localesBaseDir目录下文件，并将各个locale文件名作为该文件对应的语言
    4}

  • 返回 FileSyncAdapter 实例

• fileSyncAdapter.getLocale

  • 参数 languag, 语言类型
  • 返回 language 对应的 locale 数据

ObjectAdapter

• 构造函数 ObjectAdapter

  • 参数 locales, 保存 locales 信息的对象

  1{
  2  "zh": {
  3    "user": {
  4      "name": "PicGo",
  5      "country": "China"
  6    },
  7    "report": {
  8      "singular": " ${cnt}个报告",
  9      "plural": "${cnt}个报告"
  10    }
  11  },
  12  "en": {
  13    "user": {
  14      "name": "PicGo",
  15      "country": "China"
  16    },
  17    "report": {
  18      "singular": "only ${cnt} report",
  19      "plural": "${cnt} reports"
  20    }
  21  }
  22}

  • 返回 ObjectAdapter 实例

• objectAdapter.getLocale

  • 参数 languag, 语言类型
  • 返回 language 对应的 locale 数据

• objectAdapter.setLocales 用于动态修改 objectAdapter 上的 locales 数据

  • 参数 locales, locales 数据
  • 无返回值

  1objectAdapter.setLocales({
  2  zh: {
  3    newData: 'this is new Data',
  4  },
  5});

License

MIT

Copyright (c) 2020 PicGo Group