国际化生命周期

插件使用这些生命周期加载与国际化相关的数据。

getTranslationFiles({content})

插件声明它们想要使用的 JSON 翻译文件。

返回翻译文件 {path: string, content: ChromeI18nJSON}

• path：相对于插件本地化文件夹 i18n/[locale]/[pluginName]。为了保持通用性，应省略扩展名 .json。
• content：使用 Chrome i18n JSON 格式。

这些文件将由 write-translations CLI 写入到插件的 i18n 子文件夹中，并在调用 translateContent() 和 translateThemeConfig() 之前，在相应的语言环境中读取。

示例

my-plugin.js

export default function (context, options) {
  return {
    name: 'my-plugin',
    async getTranslationFiles({content}) {
      return [
        {
          path: 'sidebar-labels',
          content: {
            someSidebarLabel: {
              message: 'Some Sidebar Label',
              description: 'A label used in my plugin in the sidebar',
            },
            someLabelFromContent: content.myLabel,
          },
        },
      ];
    },
  };
}

translateContent({content,translationFiles})

使用本地化的翻译文件翻译插件内容。

返回本地化的插件内容。

contentLoaded() 生命周期将使用 translateContent() 返回的本地化插件内容被调用。

示例

my-plugin.js

export default function (context, options) {
  return {
    name: 'my-plugin',
    translateContent({content, translationFiles}) {
      const myTranslationFile = translationFiles.find(
        (f) => f.path === 'myTranslationFile',
      );
      return {
        ...content,
        someContentLabel: myTranslationFile.someContentLabel.message,
      };
    },
  };
}

translateThemeConfig({themeConfig,translationFiles})

使用本地化的翻译文件翻译站点 themeConfig 标签。

返回本地化的 themeConfig。

示例

my-plugin.js

export default function (context, options) {
  return {
    name: 'my-theme',
    translateThemeConfig({themeConfig, translationFiles}) {
      const myTranslationFile = translationFiles.find(
        (f) => f.path === 'myTranslationFile',
      );
      return {
        ...themeConfig,
        someThemeConfigLabel: myTranslationFile.someThemeConfigLabel.message,
      };
    },
  };
}

async getDefaultCodeTranslationMessages()

使用 <Translate> API 的主题可以提供默认代码翻译消息。

它应该返回 Record<string, string> 中的消息，其中键是翻译 ID，值是使用站点的当前语言环境本地化的消息（不包含描述）。

示例

my-plugin.js

export default function (context, options) {
  return {
    name: 'my-theme',
    async getDefaultCodeTranslationMessages() {
      return readJsonFile(`${context.i18n.currentLocale}.json`);
    },
  };
}