@gm-mobile/locales 3.12.12-beta.0 → 3.12.13
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +94 -0
- package/package.json +2 -2
package/README.md
ADDED
|
@@ -0,0 +1,94 @@
|
|
|
1
|
+
# @gm-mobile/locales
|
|
2
|
+
|
|
3
|
+
## 简介
|
|
4
|
+
国际化工具包 - 提供多语言支持和国际化工具函数，被其他组件库内部使用。
|
|
5
|
+
|
|
6
|
+
## 安装
|
|
7
|
+
|
|
8
|
+
```bash
|
|
9
|
+
npm install @gm-mobile/locales
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
## 使用
|
|
13
|
+
|
|
14
|
+
### 快速开始
|
|
15
|
+
|
|
16
|
+
```jsx
|
|
17
|
+
import { getLocale, setLocale } from '@gm-mobile/locales'
|
|
18
|
+
|
|
19
|
+
// 设置当前语言
|
|
20
|
+
setLocale('en')
|
|
21
|
+
|
|
22
|
+
// 获取翻译文本
|
|
23
|
+
const text = getLocale('确定') // 返回 "OK"
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
## API
|
|
27
|
+
|
|
28
|
+
### 导出列表
|
|
29
|
+
|
|
30
|
+
| 导出项 | 类型 | 说明 |
|
|
31
|
+
|--------|------|------|
|
|
32
|
+
| `getLocale` | 函数 | 根据当前语言获取翻译文本 |
|
|
33
|
+
| `setLocale` | 函数 | 设置当前语言 |
|
|
34
|
+
|
|
35
|
+
### 函数
|
|
36
|
+
|
|
37
|
+
#### `setLocale(lng)`
|
|
38
|
+
|
|
39
|
+
设置当前语言。
|
|
40
|
+
|
|
41
|
+
| 参数 | 说明 | 类型 | 必填 |
|
|
42
|
+
|------|------|------|------|
|
|
43
|
+
| lng | 语言标识 | `string` | 是 |
|
|
44
|
+
|
|
45
|
+
#### `getLocale(text)`
|
|
46
|
+
|
|
47
|
+
根据当前语言获取翻译文本，找不到翻译时返回原文。
|
|
48
|
+
|
|
49
|
+
| 参数 | 说明 | 类型 | 必填 |
|
|
50
|
+
|------|------|------|------|
|
|
51
|
+
| text | 需要翻译的中文文本 | `string` | 是 |
|
|
52
|
+
|
|
53
|
+
**返回值**：`string` - 翻译后的文本
|
|
54
|
+
|
|
55
|
+
### 支持的语言
|
|
56
|
+
|
|
57
|
+
| 语言标识 | 说明 |
|
|
58
|
+
|----------|------|
|
|
59
|
+
| `zh` | 简体中文（默认） |
|
|
60
|
+
| `zh-HK` | 繁体中文（香港） |
|
|
61
|
+
| `en` | 英文 |
|
|
62
|
+
| `th` | 泰文 |
|
|
63
|
+
| `ug` | 维吾尔文 |
|
|
64
|
+
|
|
65
|
+
## 示例
|
|
66
|
+
|
|
67
|
+
### 切换语言
|
|
68
|
+
|
|
69
|
+
```jsx
|
|
70
|
+
import { getLocale, setLocale } from '@gm-mobile/locales'
|
|
71
|
+
|
|
72
|
+
const App = () => {
|
|
73
|
+
return (
|
|
74
|
+
<div>
|
|
75
|
+
<button onClick={() => setLocale('zh')}>中文</button>
|
|
76
|
+
<button onClick={() => setLocale('en')}>English</button>
|
|
77
|
+
<button onClick={() => setLocale('th')}>ไทย</button>
|
|
78
|
+
|
|
79
|
+
<p>{getLocale('确定')}</p>
|
|
80
|
+
<p>{getLocale('取消')}</p>
|
|
81
|
+
</div>
|
|
82
|
+
)
|
|
83
|
+
}
|
|
84
|
+
```
|
|
85
|
+
|
|
86
|
+
## 注意事项
|
|
87
|
+
- 默认语言为简体中文（`zh`）
|
|
88
|
+
- 找不到对应翻译时会返回原文（中文 key）
|
|
89
|
+
- 语言包文件由脚本自动生成，位于 `src/lng/` 目录下
|
|
90
|
+
- 其他组件库（如 `@gm-mobile/c-react`、`@gm-mobile/react`）内部依赖此包进行国际化
|
|
91
|
+
|
|
92
|
+
## 相关包
|
|
93
|
+
- [@gm-mobile/c-react](../c-react) - 基础 React 组件
|
|
94
|
+
- [@gm-mobile/react](../react) - 主组件库
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@gm-mobile/locales",
|
|
3
|
-
"version": "3.12.
|
|
3
|
+
"version": "3.12.13",
|
|
4
4
|
"description": "",
|
|
5
5
|
"author": "liyatang <liyatang@qq.com>",
|
|
6
6
|
"homepage": "https://github.com/gmfe/gm-mobile#readme",
|
|
@@ -20,5 +20,5 @@
|
|
|
20
20
|
"bugs": {
|
|
21
21
|
"url": "https://github.com/gmfe/gm-mobile/issues"
|
|
22
22
|
},
|
|
23
|
-
"gitHead": "
|
|
23
|
+
"gitHead": "f1807b01b33bb8ee331b6c713d52d85fda524bf7"
|
|
24
24
|
}
|