@halofe/global-string-format

@halofe/global-string-format

@halofe/global-string-format 提供普通文案国际化能力，业务方传入数据字典，组件返回 id 对应的文案。

$3

- 提供获取普通文案的国际化能力
- 可以在浏览器和 node 环境中运行
- 基于国际化多语言标准
- 支持 react/rax 对象作为变量
- 同时支持 index 和 name 作为变量索引
- 结合使用 babel-plugin-string-format 可以解决依赖组件的文案收集和透传的问题

$3

``
tnpm install @halofe/global-string-format --save
`

$3

#### 基本使用

`js
// src/index.js

import stringFormat from "@halofe/global-string-format";

// 初始化一个实例,并将这个实例挂载到全局变量(window/global)上. 在一些通用组件可以直接用这个实例进行格式化.
stringFormat.init("en-US", {
"en-US": {
no_variable: "I have noe messages",
variable_test_for_index: "I have {0} messages",
variable_test_for_name: "I have {count} messages",
},
"zh-CN": {
no_variable: "我没有消息",
variable_test_for_index: "我有 {0} 条消息",
variable_test_for_name: "我有 {count} 条消息",
},
});

// 输出多语言
stringFormat.format({
id: "no_variable",
defaultString: "I have noe messages",
});
// 输出
// I have noe messages

// 使用 index 作为变量的索引
stringFormat.format(
{
id: "variable_test_for_index",
defaultString: "I have {0} messages",
},
[2]
);

// 输出
// I have 2 messages

// 使用 name 作为变量的缩影
stringFormat.format(
{
id: "variable_test_for_name",
defaultString: "I have {count} messages",
},
{ count: 1 }
);

// 输出
// I have 2 messages
`

在其他的页面或者依赖组件中, 直接调用 stringFormat.Format , 使用首次初始化的实例进行格式化.

`js
// src/component/other/index.js
import stringFormat from "@halofe/global-string-format";
// 使用全局共享的实例进行多语言格式化
stringFormat.format({
id: "no_variable",
defaultString: "I have noe messages",
});
// 输出
// I have noe messages
`

#### React Dom 作为变量

`js
import from 'react';
import stringFormat from '@halofe/global-string-format';
const messageCountSpan = (2);
stringFormat.format({
id: 'variable_test_for_index',
defaultString: 'I have {0} messages'
},[messageCountSpan],{
React // 注意: 需要将 React 作为参数传入
})
`

$3

#### 使用 StringFormat 对象

1.StringFormat：使用 StringFormat 实例化。
2.format：使用 StringFormat 实例的 format 方法，返回每条 id 对应的文案。

`js
import sf from "@halofe/global-string-format";
/**
* @param locale Languages that need to be localized
* @param strings Data dictionary, ICU grammar
*/
const stringFormat = new sf.StringFormat("zh-CN", {
"en-US": {
hello_world: "hello world",
},
"zh-CN": {
hello_world: "你好，国际化",
},
});

// 获取传入的 strings
stringFormat.getStrings();

// 进行格式化
stringFormat.format({
id: "hello_world",
defaultString: "hello world",
});
``