目前支持语言
| 最低支持版本 | 语言 |
|---|---|
| v0.0.1 | 简体中文: zh_CN |
| v0.7.0 | 英语: en_GB、日语: ja_JP、韩语: ko_KR |
| v1.8.0 | 阿拉伯语: ar |
| v1.11.0 | 越南语: vi_VN、俄罗斯语: ru_RU、印尼语: id_ID、马来语: ms_MY、泰语: th_TH、土耳其语: tr_TR |
| v1.17.0 | 葡萄牙语(巴西): pt_BR |
| v1.28.0 | 繁体中文: zh_TW |
| v2.2.0 | 西班牙语: es |
| v2.15.0 | 意大利语: it、法语:fr、德语:de |
| v2.21.0 | 罗马尼亚语: ro |
| v2.29.0 | 瑞典语: sv_SE、波兰语: pl_PL、荷兰语: nl_NL |
| v2.88.0 | 阿塞拜疆语:az、保加利亚语:bg、加泰罗尼亚语:ca、捷克语:cs_CZ、宿务语:ceb_PH、丹麦语: da、希腊语:el_GR、西班牙语(拉美):es_419、爱沙尼亚语:et、波斯语:fa_IR、菲律宾语:fil_PH、芬兰语: fi_FI、法语(加):fr_CA、爱尔兰语:ga、希伯来语:he_IL、印地语:hi_IN、克罗地亚语:hr、匈牙利语:hu_HU、冰岛语:is、爪哇语:jv_ID、哈萨克语:kk、高棉语:km_KH、立陶宛语:lt、拉脱维亚语:lv、缅甸语:my_MM、挪威语: nb、葡萄牙语:pt、斯洛伐克语:sk、斯洛文尼亚语:sl、阿尔巴尼亚语:sq、斯瓦希里语:sw、乌克兰语:uk_UA、乌尔都语:ur、乌兹别克语:uz |
已支持组件
目前有以下组件存在内置默认文本,均已实现国际化多语言适配
Calendar、Cascader、Chat、DatePicker、Form、Image、List、Modal、Navigation、Nav、Pagination、Popconfirm、Select、Table、TimePicker、Transfer、Tree、TreeSelect、Typography、Upload
使用
LocaleProvider 使用 context 向后代传递语言包,你只需要在应用外围包裹一次即可全局生效
当需要切换语言时,把 locale 绑定到随之变化的值上即可,子树会自动更新。
import en_GB from '@fibrous/semi-foundation/locale/source/en_GB';
import { LocaleProvider } from '@fibrous/semi-ui-solid';
() => (
<LocaleProvider locale={en_GB}>
<App />
</LocaleProvider>
);
不传 locale 时 LocaleProvider 继承外层 LocaleProvider 的语言,最外层都没有时回退 zh_CN;ConfigProvider 的 locale 优先于 LocaleProvider。
代码示例
国际化
- Total pages: 10
- Items per page: 10
- 合計ページ数:10
- 1ページあたりのアイテム数:10
代码
import en_GB from '@fibrous/semi-foundation/locale/source/en_GB';
import ja_JP from '@fibrous/semi-foundation/locale/source/ja_JP';
import { LocaleProvider, Pagination } from '@fibrous/semi-ui-solid';
export default function LocaleDemo() {
return (
<>
<LocaleProvider locale={en_GB}>
<Pagination total={100} showTotal showSizeChanger style={{ margin: '20px' }} />
</LocaleProvider>
<LocaleProvider locale={ja_JP}>
<Pagination total={100} showTotal showSizeChanger style={{ margin: '20px' }} />
</LocaleProvider>
</>
);
}自定义国际化组件
当你的自定义组件,也希望消费 Semi LocaleProvider 中的 localeCode 或者读取具体某个组件的 i18n 文本时,你可以使用 LocaleConsumer 获取:它的子节点是函数,参数依次为组件文案片段(locale)、localeCode、dateFnsLocale 与 currency。在组件体中也可以调用 useLocale(componentName),它返回一个访问器,调用它即可读到同样四项。语言的优先级为 ConfigProvider、LocaleProvider、zh_CN。自定义命名空间(示例中的 ComponentA)通过 declaration merging 扩展 Locale 类型。
代码
import en_GB from '@fibrous/semi-foundation/locale/source/en_GB';
import ko_KR from '@fibrous/semi-foundation/locale/source/ko_KR';
import zh_CN from '@fibrous/semi-foundation/locale/source/zh_CN';
import { LocaleProvider, LocaleConsumer } from '@fibrous/semi-ui-solid';
// Custom component text joins the Locale type through declaration merging
declare module '@fibrous/semi-foundation/locale/interface' {
interface Locale {
ComponentA: { customKey: string };
}
}
function GetLocaleFromSemi() {
return (
<LocaleConsumer componentName="TimePicker">
{(localeData, localeCode) => (
<div>
{localeCode} : {localeData.begin}
</div>
)}
</LocaleConsumer>
);
}
function ExtractComponent() {
return <LocaleConsumer componentName="ComponentA">{(localeData) => <div>{localeData.customKey}</div>}</LocaleConsumer>;
}
export default function LocaleDemo() {
const zhWithCustom = { ...zh_CN, ComponentA: { customKey: 'semi' } };
const koWithCustom = { ...ko_KR, ComponentA: { customKey: 'design' } };
const enWithCustom = { ...en_GB, ComponentA: { customKey: 'dsm' } };
return (
<>
<LocaleProvider locale={zhWithCustom}>
<GetLocaleFromSemi />
</LocaleProvider>
<LocaleProvider locale={koWithCustom}>
<GetLocaleFromSemi />
</LocaleProvider>
<LocaleProvider locale={enWithCustom}>
<GetLocaleFromSemi />
</LocaleProvider>
<LocaleProvider locale={zhWithCustom}>
<ExtractComponent />
</LocaleProvider>
<LocaleProvider locale={koWithCustom}>
<ExtractComponent />
</LocaleProvider>
<LocaleProvider locale={enWithCustom}>
<ExtractComponent />
</LocaleProvider>
</>
);
}支持多语言的组件
示例给出了目前所有支持多语言的组件
当你的网站有RTL适配需求时,推荐直接使用ConfigProvider,除了可配置locale外,还可以直接同时配置direction='rtl'/'ltr'
若无RTL适配需求,直接使用LocaleProvider即可
Pagination
- 总页数:10
- 每页条数:10
- 跳至页
Modal
Select & Cascader
DatePicker
TimePicker
TreeSelect
Table
| Name | Age | Address |
|---|
| Bytedance 0 | 32 | Beijing, Haidian. Zhichun Road 0 |
| Bytedance 1 | 32 | Beijing, Haidian. Zhichun Road 1 |
| Bytedance 2 | 32 | Beijing, Haidian. Zhichun Road 2 |
| Bytedance 3 | 32 | Beijing, Haidian. Zhichun Road 3 |
| Bytedance 4 | 32 | Beijing, Haidian. Zhichun Road 4 |
| Bytedance 5 | 32 | Beijing, Haidian. Zhichun Road 5 |
| Bytedance 6 | 32 | Beijing, Haidian. Zhichun Road 6 |
| Bytedance 7 | 32 | Beijing, Haidian. Zhichun Road 7 |
| Bytedance 8 | 32 | Beijing, Haidian. Zhichun Road 8 |
| Bytedance 9 | 32 | Beijing, Haidian. Zhichun Road 9 |
Table - Empty
| Name | Age | Address |
|---|
List - Empty
Calendar
Typography - Copyable
Click to copy text.
Typography - Collapsible
支持展开和折叠:Semi Design 是由抖音前端团队与 UED 团队共同设计开发并维护的设计系统。设计系统包含设计语言以及一整套可复用的前端组件,帮助设计师与开发者更容易地打造高质量的、用户体验一致的、符合设计规范的 Web 应用。
Transfer
Image




Form
Navigation
代码
import { createSignal, For } from 'solid-js';
import type { Locale } from '@fibrous/semi-foundation/locale/interface';
import zh_CN from '@fibrous/semi-foundation/locale/source/zh_CN';
import { IconUser, IconSemiLogo, IconStar } from '@fibrous/semi-icons-solid';
import { LocaleProvider, ConfigProvider, Pagination, Modal, Button, Select, Cascader, DatePicker, TreeSelect, Table, TimePicker, List, Calendar, Typography, Transfer, ImagePreview, Image, Form, FormInput, Nav, type ColumnProps } from '@fibrous/semi-ui-solid';
// A pack loads when it is picked, so the page does not bundle every language up front
const loaders = {
ar: () => import('@fibrous/semi-foundation/locale/source/ar'),
az: () => import('@fibrous/semi-foundation/locale/source/az'),
bg: () => import('@fibrous/semi-foundation/locale/source/bg'),
bn_IN: () => import('@fibrous/semi-foundation/locale/source/bn_IN'),
ca: () => import('@fibrous/semi-foundation/locale/source/ca'),
ceb_PH: () => import('@fibrous/semi-foundation/locale/source/ceb_PH'),
cs_CZ: () => import('@fibrous/semi-foundation/locale/source/cs_CZ'),
da: () => import('@fibrous/semi-foundation/locale/source/da'),
de: () => import('@fibrous/semi-foundation/locale/source/de'),
el_GR: () => import('@fibrous/semi-foundation/locale/source/el_GR'),
en_GB: () => import('@fibrous/semi-foundation/locale/source/en_GB'),
en_US: () => import('@fibrous/semi-foundation/locale/source/en_US'),
es: () => import('@fibrous/semi-foundation/locale/source/es'),
es_419: () => import('@fibrous/semi-foundation/locale/source/es_419'),
et: () => import('@fibrous/semi-foundation/locale/source/et'),
fa_IR: () => import('@fibrous/semi-foundation/locale/source/fa_IR'),
fi_FI: () => import('@fibrous/semi-foundation/locale/source/fi_FI'),
fil_PH: () => import('@fibrous/semi-foundation/locale/source/fil_PH'),
fr: () => import('@fibrous/semi-foundation/locale/source/fr'),
fr_CA: () => import('@fibrous/semi-foundation/locale/source/fr_CA'),
ga: () => import('@fibrous/semi-foundation/locale/source/ga'),
he_IL: () => import('@fibrous/semi-foundation/locale/source/he_IL'),
hi_IN: () => import('@fibrous/semi-foundation/locale/source/hi_IN'),
hr: () => import('@fibrous/semi-foundation/locale/source/hr'),
hu_HU: () => import('@fibrous/semi-foundation/locale/source/hu_HU'),
id_ID: () => import('@fibrous/semi-foundation/locale/source/id_ID'),
is: () => import('@fibrous/semi-foundation/locale/source/is'),
it: () => import('@fibrous/semi-foundation/locale/source/it'),
ja_JP: () => import('@fibrous/semi-foundation/locale/source/ja_JP'),
jv_ID: () => import('@fibrous/semi-foundation/locale/source/jv_ID'),
kk: () => import('@fibrous/semi-foundation/locale/source/kk'),
km_KH: () => import('@fibrous/semi-foundation/locale/source/km_KH'),
ko_KR: () => import('@fibrous/semi-foundation/locale/source/ko_KR'),
lt: () => import('@fibrous/semi-foundation/locale/source/lt'),
lv: () => import('@fibrous/semi-foundation/locale/source/lv'),
ms_MY: () => import('@fibrous/semi-foundation/locale/source/ms_MY'),
my_MM: () => import('@fibrous/semi-foundation/locale/source/my_MM'),
nb: () => import('@fibrous/semi-foundation/locale/source/nb'),
nl_NL: () => import('@fibrous/semi-foundation/locale/source/nl_NL'),
pl_PL: () => import('@fibrous/semi-foundation/locale/source/pl_PL'),
pt: () => import('@fibrous/semi-foundation/locale/source/pt'),
pt_BR: () => import('@fibrous/semi-foundation/locale/source/pt_BR'),
ro: () => import('@fibrous/semi-foundation/locale/source/ro'),
ru_RU: () => import('@fibrous/semi-foundation/locale/source/ru_RU'),
sk: () => import('@fibrous/semi-foundation/locale/source/sk'),
sl: () => import('@fibrous/semi-foundation/locale/source/sl'),
sq: () => import('@fibrous/semi-foundation/locale/source/sq'),
sv_SE: () => import('@fibrous/semi-foundation/locale/source/sv_SE'),
sw: () => import('@fibrous/semi-foundation/locale/source/sw'),
th_TH: () => import('@fibrous/semi-foundation/locale/source/th_TH'),
tr_TR: () => import('@fibrous/semi-foundation/locale/source/tr_TR'),
uk_UA: () => import('@fibrous/semi-foundation/locale/source/uk_UA'),
ur: () => import('@fibrous/semi-foundation/locale/source/ur'),
uz: () => import('@fibrous/semi-foundation/locale/source/uz'),
vi_VN: () => import('@fibrous/semi-foundation/locale/source/vi_VN'),
zh_TW: () => import('@fibrous/semi-foundation/locale/source/zh_TW'),
};
type LocaleCode = 'zh_CN' | keyof typeof loaders;
interface Current {
code: LocaleCode;
locale: Locale;
}
interface Person {
key: string;
name: string;
age: number;
address: string;
}
const treeData = [
{
label: 'Asia',
value: 'asia',
key: '1',
children: [
{
label: 'China',
value: 'china',
key: '1-0',
children: [
{ label: 'Beijing', value: 'beijing', key: '1-0-0' },
{ label: 'Shanghai', value: 'shanghai', key: '1-0-1' },
],
},
{
label: 'Japan',
value: 'japan',
key: '1-1',
children: [{ label: 'Osaka', value: 'osaka', key: '1-1-0' }],
},
],
},
];
const columns: ColumnProps<Person>[] = [
{
title: 'Name',
width: 250,
dataIndex: 'name',
},
{
title: 'Age',
width: 150,
dataIndex: 'age',
},
{
title: 'Address',
dataIndex: 'address',
},
];
const tableData: Person[] = Array.from({ length: 46 }, (_, i) => ({
key: '' + i,
name: `Bytedance ${i}`,
age: 32,
address: `Beijing, Haidian. Zhichun Road ${i}`,
}));
const transferData = Array.from({ length: 100 }, (_, i) => ({
label: `选项名称 ${i}`,
value: i,
disabled: false,
key: i,
}));
const srcList = ['/assets/root-web-sites/abstract.jpg', '/assets/root-web-sites/sky.jpg', '/assets/root-web-sites/greenleaf.jpg', '/assets/root-web-sites/colorful.jpg'];
const style = { margin: '10px' };
function I18nComponent() {
const [modalVisible, setModalVisible] = createSignal(false);
const navItems = [
{ itemKey: 'user', text: '用户管理' },
{ itemKey: 'union', text: '活动管理' },
];
const navHeader = {
logo: () => <IconSemiLogo style={{ height: '36px', 'font-size': '36px' }} />,
text: 'Semi 数据后台',
};
return (
<>
<h5>Pagination</h5>
<Pagination total={100} showTotal showSizeChanger style={style} showQuickJumper />
<h5>Modal</h5>
<div style={style}>
<Button onClick={() => setModalVisible(true)}>Show Modal</Button>
<Modal title="Modal" visible={modalVisible()} onOk={() => setModalVisible(false)} onCancel={() => setModalVisible(false)}>
<p>This is the content of a basic modal.</p>
<p>More content...</p>
</Modal>
</div>
<h5>Select & Cascader</h5>
<div style={style}>
<Select aria-label="Select" filter style={{ width: '180px' }}>
<Select.Option value="abc">abc</Select.Option>
<Select.Option value="vigo" disabled>
vigo
</Select.Option>
<Select.Option value="hotsoon">hotsoon</Select.Option>
</Select>
<Cascader style={{ width: '300px', margin: '10px' }} treeData={treeData} filterTreeNode prefix="Cascader" />
</div>
<h5>DatePicker</h5>
<DatePicker style={{ ...style, width: '250px' }} />
<DatePicker style={{ ...style, width: '300px' }} type="dateTime" />
<DatePicker style={{ ...style, width: '300px' }} type="dateRange" />
<DatePicker style={{ ...style, width: '450px' }} type="dateTimeRange" />
<h5>TimePicker</h5>
<TimePicker style={style} />
<TimePicker use12Hours style={style} />
<br />
<br />
<h5>TreeSelect</h5>
<TreeSelect style={{ ...style, width: '300px' }} dropdownStyle={{ 'max-height': '400px', overflow: 'auto' }} treeData={treeData} filterTreeNode />
<h5>Table</h5>
<Table columns={columns} dataSource={tableData} scroll={{ y: 320 }} />
<h5>Table - Empty</h5>
<Table columns={columns} dataSource={[]} scroll={{ y: 320 }} />
<h5>List - Empty</h5>
<List header={<div>List</div>} dataSource={[]} />
<h5>Calendar</h5>
<Calendar mode="month" displayValue={new Date(2024, 4, 6, 12)} />
<h5>Typography - Copyable</h5>
<Typography.Paragraph copyable>Click to copy text.</Typography.Paragraph>
<h5>Typography - Collapsible</h5>
<Typography.Paragraph ellipsis={{ rows: 3, expandable: true, collapsible: true }} style={{ width: '300px' }}>
支持展开和折叠:Semi Design 是由抖音前端团队与 UED 团队共同设计开发并维护的设计系统。设计系统包含设计语言以及一整套可复用的前端组件,帮助设计师与开发者更容易地打造高质量的、用户体验一致的、符合设计规范的 Web 应用。
</Typography.Paragraph>
<h5>Transfer</h5>
<Transfer style={{ width: '568px', height: '416px' }} dataSource={transferData} />
<h5>Image</h5>
<ImagePreview showTooltip>
<For each={srcList}>{(src, index) => <Image src={src} width={200} alt={`lamp${index() + 1}`} style={{ 'margin-right': '5px' }} />}</For>
</ImagePreview>
<h5>Form</h5>
<Form layout="horizontal" onValueChange={(values) => console.log(values)}>
<FormInput field="UserName" label={{ text: '角色', optional: true }} style={{ width: '200px' }} />
</Form>
<h5>Navigation</h5>
<Nav bodyStyle={{ height: '320px' }} items={navItems} renderItemIcon={({ item }) => (item.itemKey === 'user' ? <IconUser /> : <IconStar />)} header={navHeader} footer={{ collapseButton: true }} />
</>
);
}
export default function LocaleDemo() {
const [current, setCurrent] = createSignal<Current>({ code: 'zh_CN', locale: zh_CN });
let latest: LocaleCode = 'zh_CN';
const onLanguageChange = async (code: LocaleCode) => {
latest = code;
const locale = code === 'zh_CN' ? zh_CN : (await loaders[code]()).default;
// A pick made while this pack was loading wins
if (latest === code) {
setCurrent({ code, locale });
}
};
return (
<>
<div style={{ 'border-bottom': '1px solid var(--semi-color-border)', 'padding-bottom': '20px' }}>
<Select aria-label="切换语言" onChange={(value) => onLanguageChange(value as LocaleCode)} prefix="切换语言" style={{ width: '250px' }} defaultValue="zh_CN">
<Select.Option value="zh_CN">简体中文</Select.Option>
<Select.Option value="en_US">英语(美)</Select.Option>
<Select.Option value="en_GB">英语(英)</Select.Option>
<Select.Option value="ja_JP">日语</Select.Option>
<Select.Option value="ko_KR">韩语</Select.Option>
<Select.Option value="ar">阿拉伯语</Select.Option>
<Select.Option value="vi_VN">越南语</Select.Option>
<Select.Option value="ru_RU">俄罗斯语</Select.Option>
<Select.Option value="id_ID">印尼语</Select.Option>
<Select.Option value="ms_MY">马来语</Select.Option>
<Select.Option value="th_TH">泰语</Select.Option>
<Select.Option value="tr_TR">土耳其语</Select.Option>
<Select.Option value="pt_BR">葡萄牙语(巴西)</Select.Option>
<Select.Option value="zh_TW">繁体中文</Select.Option>
<Select.Option value="es">西班牙语</Select.Option>
<Select.Option value="de">德语</Select.Option>
<Select.Option value="it">意大利语</Select.Option>
<Select.Option value="fr">法语</Select.Option>
<Select.Option value="ro">罗马尼亚语</Select.Option>
<Select.Option value="sv_SE">瑞典语</Select.Option>
<Select.Option value="pl_PL">波兰语</Select.Option>
<Select.Option value="nl_NL">荷兰语</Select.Option>
<Select.Option value="az">阿塞拜疆语</Select.Option>
<Select.Option value="bn_IN">孟加拉语</Select.Option>
<Select.Option value="bg">保加利亚语</Select.Option>
<Select.Option value="ca">加泰罗尼亚语</Select.Option>
<Select.Option value="cs_CZ">捷克语</Select.Option>
<Select.Option value="ceb_PH">宿务语</Select.Option>
<Select.Option value="da">丹麦语</Select.Option>
<Select.Option value="el_GR">希腊语</Select.Option>
<Select.Option value="es_419">西班牙语(拉美)</Select.Option>
<Select.Option value="et">爱沙尼亚语</Select.Option>
<Select.Option value="fa_IR">波斯语</Select.Option>
<Select.Option value="fil_PH">菲律宾语</Select.Option>
<Select.Option value="fi_FI">芬兰语</Select.Option>
<Select.Option value="fr_CA">法语(加)</Select.Option>
<Select.Option value="ga">爱尔兰语</Select.Option>
<Select.Option value="he_IL">希伯来语</Select.Option>
<Select.Option value="hi_IN">印地语</Select.Option>
<Select.Option value="hr">克罗地亚语</Select.Option>
<Select.Option value="hu_HU">匈牙利语</Select.Option>
<Select.Option value="is">冰岛语</Select.Option>
<Select.Option value="jv_ID">爪哇语</Select.Option>
<Select.Option value="kk">哈萨克语</Select.Option>
<Select.Option value="km_KH">高棉语</Select.Option>
<Select.Option value="lt">立陶宛语</Select.Option>
<Select.Option value="lv">拉脱维亚语</Select.Option>
<Select.Option value="my_MM">缅甸语</Select.Option>
<Select.Option value="nb">挪威语</Select.Option>
<Select.Option value="pt">葡萄牙语</Select.Option>
<Select.Option value="sk">斯洛伐克语</Select.Option>
<Select.Option value="sl">斯洛文尼亚语</Select.Option>
<Select.Option value="sq">阿尔巴尼亚语</Select.Option>
<Select.Option value="sw">斯瓦希里语</Select.Option>
<Select.Option value="uk_UA">乌克兰语</Select.Option>
<Select.Option value="ur">乌尔都语</Select.Option>
<Select.Option value="uz">乌兹别克语</Select.Option>
</Select>
</div>
<LocaleProvider locale={current().locale}>
<ConfigProvider direction={current().code === 'ar' ? 'rtl' : 'ltr'} locale={current().locale}>
{/* Keyed by the Current object so each language switch remounts the demo, as the React version does with key */}
<For each={[current()]}>{() => <I18nComponent />}</For>
</ConfigProvider>
</LocaleProvider>
</>
);
}API 参考
LocaleProvider
Props
| 属性 | 说明 | 类型 | 默认值 |
|---|---|---|---|
| children | 使用该语言包的子树。 | JSX.Element | - |
| locale | 语言包。不传、传 undefined 或 null 时继承外层 LocaleProvider 的语言,最外层都没有时组件回退 zh_CN;ConfigProvider 的 locale 优先于它。 | Locale | null | - |
LocaleProvider 不渲染 DOM 元素,class、style、ref 与原生属性和事件都不会落到页面上。
LocaleConsumer
Props
| 属性 | 说明 | 类型 | 默认值 |
|---|---|---|---|
| children | 函数子节点,参数依次为 componentName 对应的文案片段 locale、localeCode、dateFnsLocale 与 currency。 | Type(componentLocale: Locale[K], localeCode: string, dateFnsLocale: LocaleResult<Locale[K]>['dateFnsLocale'], currency: string) => JSX.Element | - |
| componentName | 要读取的语言包命名空间,如 TimePicker;只接受 Locale 中声明的组件名,自定义命名空间通过 declaration merging 扩展 Locale。 | K | - |
LocaleConsumer 不渲染自己的元素,class、style、ref 与原生属性和事件都不会落到页面上。
useLocale
useLocale(componentName) 返回 Accessor<LocaleResult>,调用访问器读取结果。componentName 可以是字符串,也可以是返回字符串的访问器。
| 字段 | 说明 | 类型 |
|---|---|---|
| locale | componentName 对应的文案片段 | Locale[K] |
| localeCode | 语言代码 | string |
| dateFnsLocale | date-fns 的语言对象,缺失时由 date-fns 使用默认的 enUS | Locale(date-fns) |
| currency | 语言所在地区的 ISO 4217 货币码 | string |