Storybook 的国际化 (I18n)

在一个应用中支持多种语言是很棘手的。有些语言的单词很长，会导致意外的文本溢出。有些语言在不同地区有不同的语言环境——想想英式英语和美式英语。还有一些是从右到左阅读的，这会改变整个页面流。

面向全球受众的应用需要国际化 (i18n)，即为不同地区“本地化”应用的实践。但用户界面国际化是很繁琐的。您必须通过在开发过程中手动切换语言首选项来验证应用在每个支持的语言环境中的每种状态。

使用 Storybook，您可以将任意语言环境传递给组件，而无需更改浏览器首选项，并且只需单击一下即可切换语言环境。本指南将向您展示如何操作。

➕ 在 Storybook 中暴露 i18next 翻译
🎁 使用 i18next provider 包裹 stories
🔘 向工具栏添加语言环境切换器
👈 添加从右到左的语言支持

我们正在构建什么

大多数开发者使用 i18next，这是一个流行的 JavaScript 库，它允许应用为每个支持的语言环境定义单独的文件。它可以检测用户的语言首选项和地区，并且只加载检测到的语言环境。

语言环境不是作为输入传递给组件，而是通过上下文全局共享。让我们使用 i18next 扩展 Storybook，在工具栏中添加一个语言环境切换器，以选择要与组件共享的语言环境。

请参考 i18next-react GitHub 仓库中的代码示例进行学习。

准备工作

在我们开始之前，请确保您有一个正在运行的 React 应用，该应用使用 i18next-react 并已设置 Storybook 6.0 或更高版本。如果您需要资源来设置这些，我在下面提供了一些建议

• 设置 i18next-react
• 配置 i18next 语言检测器
• Storybook 入门

或者，如果您更喜欢视频，请查看 Chantastic 关于向您的 React 应用添加 i18next 的精彩视频。

1. 向 Storybook 暴露 i18next

为了使您的翻译在 stories 中可用，您首先需要向 Storybook 暴露您的 i18next 实例。以下是我的 React 应用中使用的 ./src/i18n.js 文件中的 i18next 实例示例。

// src/i18n.js

import i18n from 'i18next';
import Backend from 'i18next-http-backend';
import LanguageDetector from 'i18next-browser-languagedetector';
 
i18n
 .use(Backend) // lazy loads translations from /public/locales
 .use(LanguageDetector) // detect user language
 .init({
   fallbackLng: 'en',
   debug: true,
   interpolation: {
     escapeValue: false,
   },
 });
 
export default i18n;

为了向 Storybook 暴露此实例，我们可以将其导入到 ./.storybook/preview.js 文件中，Storybook 在其中保存其共享 story 配置。

// .storybook/preview.js
import i18n from '../src/i18n';

2. 使用 i18next provider 包裹您的 stories

现在 Storybook 可以访问 i18next 了，我们需要与我们的 stories 共享它。为此，我们将创建一个装饰器来包裹我们的 stories。

// .storybook/preview.js
import React, { Suspense } from "react";
import { I18nextProvider } from "react-i18next";
import i18n from '../src/i18n';
 
// Wrap your stories in the I18nextProvider component
const withI18next = (Story) => {
 return (
   // This catches the suspense from components not yet ready (still loading translations)
   // Alternative: set useSuspense to false on i18next.options.react when initializing i18next
   <Suspense fallback={<div>loading translations...</div>}>
     <I18nextProvider i18n={i18n}>
       <Story />
     </I18nextProvider>
   </Suspense>
 );
};
 
// export decorators for storybook to wrap your stories in
export const decorators = [withI18next];

太棒了！我们的 stories 现在正式可以访问我们的翻译了。如果我们更改在 ./src/i18n.js 中定义的 lng，您将看到您的 stories 以新语言重新加载。

3. 添加语言环境切换器

硬编码您的语言环境很烦人，并且对任何查看您已部署的 Storybook 的人都没有帮助，因此让我们向 Storybook 工具栏添加一个语言环境切换器。如果您想了解有关切换器的更多信息，请查看 Yann Braga 关于添加主题切换器的文章。

为此，我们可以在 .storybook/preview.js 中声明一个名为 locale 的全局变量，并将其分配给要从中选择的受支持语言列表。

// .storybook/preview.js

/* Snipped for brevity */
 
// Create a global variable called locale in storybook
// and add a menu in the toolbar to change your locale
export const globalTypes = {
 locale: {
   name: 'Locale',
   description: 'Internationalization locale',
   toolbar: {
     icon: 'globe',
     items: [
       { value: 'en', title: 'English' },
       { value: 'de', title: 'Deutsch' },
     ],
     showName: true,
   },
 },
};

回顾 Storybook，我们现在可以看到工具栏中添加了一个“Locale”切换器，其中包含我们刚刚设置的选项。

现在让我们更新我们的装饰器，以便在选择新语言时更改我们的语言环境。

// .storybook/preview.js

/* Snipped for brevity */

const withI18next = (Story, context) => {
 const { locale } = context.globals;
 
 // When the locale global changes
 // Set the new locale in i18n
 useEffect(() => {
   i18n.changeLanguage(locale);
 }, [locale]);
 
 return (
   <Suspense fallback={<div>loading translations...</div>}>
     <I18nextProvider i18n={i18n}>
       <Story />
     </I18nextProvider>
   </Suspense>
 );
};

瞧——一个功能齐全的语言环境切换器，由 i18next-react 为您的 stories 提供支持！

4. 设置文档方向

有些语言不是像英语那样从左到右阅读的。例如，阿拉伯语是从右到左阅读的。HTML 通过 dir 属性内置了对此的支持。

首先，让我们通过在 globalTypes 的 items 数组中添加一个对象，将阿拉伯语作为选项添加到我们的语言环境切换器中。

// .storybook/preview.js

/* Snipped for brevity */
 
// Create a global variable called locale in storybook
// and add a menu in the toolbar to change your locale
export const globalTypes = {
 locale: {
   name: 'Locale',
   description: 'Internationalization locale',
   toolbar: {
     icon: 'globe',
     items: [
       { value: 'en', title: 'English' },
       { value: 'de', title: 'Deutsch' },
       { value: 'ar', title: 'عربي' },
     ],
     showName: true,
   },
 },
};

使用 i18next 的 dir(lng) 函数和 languageChanged 事件，我们可以为所选语言环境设置文档方向。

// .storybook/preview.js
 
/* Snipped for brevity */
 
// When The language changes, set the document direction
i18n.on('languageChanged', (locale) => {
 const direction = i18n.dir(locale);
 document.dir = direction;
});

现在，当我们把 storybook 设置为阿拉伯语时，文档方向被设置为 ”rtl” 🎉

总结

在 Storybook 中添加语言环境切换器允许您使用更长的字符串甚至像阿拉伯语这样从右到左的语言来检查您的组件。

如果您想参考我的 DIY 实现，请查看 i18next-react 的 Storybook 示例。但是，如果您希望有人为您处理此事，请查看 Stevensack 的精彩 storybook-react-i18next 插件。

想要更多指南？

我们想听听您的意见！

您喜欢这篇指南吗？您还希望看到哪些 Storybook 集成的指南？

在 Twitter 上 @storybookjs 发推文或在 Storybook Discord 服务器上联系我们！我们迫不及待想见到您 🤩