Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nk2028/opencc-js
The JavaScript version of Open Chinese Convert (OpenCC)
https://github.com/nk2028/opencc-js
chinese-characters simplified-chinese traditional-chinese
Last synced: 7 days ago
JSON representation
The JavaScript version of Open Chinese Convert (OpenCC)
- Host: GitHub
- URL: https://github.com/nk2028/opencc-js
- Owner: nk2028
- License: mit
- Created: 2020-02-27T09:40:35.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2022-11-17T12:23:17.000Z (almost 2 years ago)
- Last Synced: 2024-07-11T18:16:06.751Z (4 months ago)
- Topics: chinese-characters, simplified-chinese, traditional-chinese
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/opencc-js
- Size: 106 KB
- Stars: 225
- Watchers: 9
- Forks: 21
- Open Issues: 7
-
Metadata Files:
- Readme: README-zh-CN.md
- License: LICENSE
Awesome Lists containing this project
README
# opencc-js [](https://www.npmjs.com/package/opencc-js) [](https://github.com/nk2028/opencc-js/actions?query=workflow%3ATest) [](https://www.jsdelivr.com/package/npm/opencc-js)
开放中文转换 JavaScript 版
## 加载
**在 HTML 中加载**
加载以下 `script` 标签（择一即可）：
```html
```
自行托管的话，除了使用原先的 umd，也可以使用 es module
```html
import * as OpenCC from './dist/esm/full.js'; // 完全版
import * as OpenCC from './dist/esm/cn2t.js'; // 只需要简转繁
import * as OpenCC from './dist/esm/t2cn.js'; // 只需要繁转简
```
**在 Node.js 中加载**
```sh
npm install opencc-js
```
CommonJS
```javascript
const OpenCC = require('opencc-js');
```
ES Modules
```javascript
import * as OpenCC from 'opencc-js';
```
## 使用
**基本用法**
```javascript
// 将繁体中文（香港）转换为简体中文（中国大陆）
const converter = OpenCC.Converter({ from: 'hk', to: 'cn' });
console.log(converter('漢語')); // output: 汉语
```
- `cn`: 简体中文（中国大陆）
- `tw`: 繁体中文（台湾）
- `twp`: 且转换词汇（例如：自行車 -> 腳踏車）
- `hk`: 繁体中文（香港）
- `jp`: 日本新字体
- `t`: 繁体中文（OpenCC 标准。除非你知道自己在做什么，否则请勿使用）
**自订转换器**
```javascript
const converter = OpenCC.CustomConverter([
['香蕉', 'banana'],
['蘋果', 'apple'],
['梨', 'pear'],
]);
console.log(converter('香蕉 蘋果 梨')); // output: banana apple pear
```
或以「空白」及「|」当作分隔符号
```javascript
const converter = OpenCC.CustomConverter('香蕉 banana|蘋果 apple|梨 pear');
console.log(converter('香蕉 蘋果 梨')); // output: banana apple pear
```
**添加字词**
* `ConverterFactory` 是比较底层的函数，`Converter` 及 `CustomConverter` 都是这个函数的再包装。
* 透过 `Locale` 属性可以得到原本的字典，进而添加字词。
```javascript
const customDict = [
['“', '「'],
['”', '」'],
['‘', '『'],
['’', '』'],
];
const converter = OpenCC.ConverterFactory(
OpenCC.Locale.from.cn, // 中国大陆 => OpenCC 标准
OpenCC.Locale.to.tw.concat([customDict]) // OpenCC 标准 => 台湾+自订
);
console.log(converter('悟空道：“师父又来了。怎么叫做‘水中捞月’？”'));
// output: 悟空道：「師父又來了。怎麼叫做『水中撈月』？」
```
下面的写法也会得到相同的结果，只是内部会多做一次转换
```javascript
const customDict = [
['“', '「'],
['”', '」'],
['‘', '『'],
['’', '』'],
];
const converter = OpenCC.ConverterFactory(
OpenCC.Locale.from.cn, // 中国大陆 => OpenCC 标准
OpenCC.Locale.to.tw, // OpenCC 标准 => 台湾
[customDict] // 台湾 => 自订
);
console.log(converter('悟空道：“师父又来了。怎么叫做‘水中捞月’？”'));
// output: 悟空道：「師父又來了。怎麼叫做『水中撈月』？」
```
**DOM 操作**
HTML 属性 `lang='*'` 定义了目标。
```html
漢語
```
```javascript
// 将繁体中文（香港）转换为简体中文（中国大陆）
const converter = OpenCC.Converter({ from: 'hk', to: 'cn' });
// 设置转换起点为根节点，即转换整个页面
const rootNode = document.documentElement;
// 将所有 zh-HK 标签转为 zh-CN 标签
const HTMLConvertHandler = OpenCC.HTMLConverter(converter, rootNode, 'zh-HK', 'zh-CN');
HTMLConvertHandler.convert(); // 开始转换 -> 汉语
HTMLConvertHandler.restore(); // 复原 -> 漢語
```
class list 包含 `ignore-opencc` 的标签不会被转换（包括该标签的所有子节点）。
## 打包优化
如果使用 rollup 等工具打包程式码，以下方式能让打包工具自动移除用不到的部分，减少档案大小。
```javascript
import * as OpenCC from 'opencc-js/core'; // 核心程式码
import * as Locale from 'opencc-js/preset'; // 字典资料
const converter = OpenCC.ConverterFactory(Locale.from.hk, Locale.to.cn);
console.log(converter('漢語'));
```
备注：
* 由于这是利用 Tree Shaking，所以必须使用 ES Modules
* 在这个模式之下，没有 `Converter` 函式，必须直接使用 `ConverterFactory`