Storybook-i18n

一个用于在 Storybook 中实现最佳实践 i18n 附加组件的库

• 易于使用的区域设置配置
• 简单的下拉菜单
• 可链接到 URL 的状态，方便分享

版本

• 2.x 适用于 Storybook >=7.0.0
• 3.x 适用于 Storybook >=8.0.0
• 3.1.x 适用于 Storybook >=8.2.0

附加组件作者

作为附加组件作者，您可以将此库添加为依赖项，并在 src/manager.ts 和 src/preview.ts 文件中添加以下内容

src/manager.ts

export * from 'storybook-i18n/manager';

src/preview.ts

import type { Renderer, ProjectAnnotations } from '@storybook/types';
import i18n from 'storybook-i18n/preview';
import { withYourI18nDecorator } from './withYourDecorator';

// @ts-ignore
const i18nDecorators = i18n?.decorators || [];

const preview: ProjectAnnotations<Renderer> = {
    ...i18n,
    decorators: [...i18nDecorators, withYourI18nDecorator],
}

export default preview;

由于 Storybook 中存在一个问题（正在解决），您需要在装饰器行上方添加 @ts-ignore。

当前选定的区域设置可在全局 locale 中获得，因此您可以在装饰器中使用以下代码段访问它

import { MyProvider } from 'your-i18n-library';
import { useGlobals } from '@storybook/manager-api';

const myDecorator = (story, context) => {
  const [{locale}] = useGlobals();
  
  return <MyProvider locale={locale}>;
}

最终用户

最终用户在 .storybook/preview.ts 中配置 locales 和 locale 全局变量。

从 Storybook 8.2 开始，您应该使用 initialGlobals 而不是 globals。

locales 是一个对象，其中键是区域设置/语言的“id”，值是您要使用的该区域设置的纯文本名称。这将显示在工具栏中的下拉列表中。

const preview: Preview = {
    initialGlobals: {
        locale: "en",
        locales: {
            en: "English",
            fr: "Français",
            ja: "日本語",
        },
    },
};

用户也可以使用完整的区域设置字符串。

const preview: Preview = {
    initialGlobals: {
        locale: "en_US",
        locales: {
            en_US: "English (US)",
            en_GB: "English (GB)",
            fr_FR: "Français",
            ja_JP: "日本語",
        },
    },
};

locales 对象也可以将值作为具有 title、icon 和/或 right 键的对象。

这在您想要在左侧和/或右侧包含表情符号标志或其他字符串时很有用。

例如

const preview: Preview = {
    initialGlobals: {
        locale: 'en',
        locales: {
            en: {icon: '🇺🇸', title: 'English', right: 'US'},
            fr: {icon: '🇫🇷', title: 'Français', right: 'FR'},
            ja: {icon: '🇯🇵', title: '日本語', right: 'JP'},
        },
    },
};

或者类似这样的

const preview: Preview = {
    initialGlobals: {
        locale: 'en_US',
        locales: {
            en_US: {title: 'English', right: 'US'},
            en_GB: {title: 'English', right: 'GB'},
            fr_FR: {title: 'Français', right: 'FR'},
            ja_JP: {title: '日本語', right: 'JP'},
        },
    },
};

更改区域设置后，将在 addons-channel 上发出一个 事件。

您可以在 preview.ts 中 订阅此事件，以自己配置与您的 i18n 配置相关的全局环境设置。

该事件将 以选定的区域设置为参数 发出。

您的实现可能如下所示

import { addons } from '@storybook/preview-api'

addons.getChannel().on('LOCALE_CHANGED', (newLocale) => {
   changeMyI18nConfig(newLocale)
});

附加组件应该指示他们使用您的 i18n 实现所期望的任何格式。