cnchar-trad
Advanced tools
Comparing version 2.2.4 to 2.2.5
{ | ||
"name": "cnchar-trad", | ||
"version": "2.2.4", | ||
"version": "2.2.5", | ||
"description": "功能全面、多端支持的汉字拼音笔画js库,支持多音字、繁体字、火星文", | ||
@@ -5,0 +5,0 @@ "main": "index.js", |
220
README.md
@@ -57,16 +57,17 @@ <p align="center"> | ||
* [5.8 歇后语功能](#58-%E6%AD%87%E5%90%8E%E8%AF%AD%E5%8A%9F%E8%83%BD) | ||
* [5.9 汉字、拼音工具方法](#59-%E6%B1%89%E5%AD%97%E6%8B%BC%E9%9F%B3%E5%B7%A5%E5%85%B7%E6%96%B9%E6%B3%95) | ||
+ [5.9.1 查询拼音详细信息: spellInfo](#591-%E6%9F%A5%E8%AF%A2%E6%8B%BC%E9%9F%B3%E8%AF%A6%E7%BB%86%E4%BF%A1%E6%81%AF-spellinfo) | ||
+ [5.9.2 拼音音调操作: transformTone](#592-%E6%8B%BC%E9%9F%B3%E9%9F%B3%E8%B0%83%E6%93%8D%E4%BD%9C-transformtone) | ||
+ [5.9.3 是否是汉字: isCnChar](#593-%E6%98%AF%E5%90%A6%E6%98%AF%E6%B1%89%E5%AD%97-iscnchar) | ||
+ [5.9.4 比较拼音(汉字)大小: compareSpell](#594-%E6%AF%94%E8%BE%83%E6%8B%BC%E9%9F%B3%E6%B1%89%E5%AD%97%E5%A4%A7%E5%B0%8F-comparespell) | ||
+ [5.9.5 比较汉字笔画数大小: compareStroke](#595-%E6%AF%94%E8%BE%83%E6%B1%89%E5%AD%97%E7%AC%94%E7%94%BB%E6%95%B0%E5%A4%A7%E5%B0%8F-comparestroke) | ||
+ [5.9.6 根据拼音排序: sortSpell](#596-%E6%A0%B9%E6%8D%AE%E6%8B%BC%E9%9F%B3%E6%8E%92%E5%BA%8F-sortspell) | ||
+ [5.9.7 根据笔画数排序: sortStroke](#597-%E6%A0%B9%E6%8D%AE%E7%AC%94%E7%94%BB%E6%95%B0%E6%8E%92%E5%BA%8F-sortstroke) | ||
* [5.10 其他 api](#510-%E5%85%B6%E4%BB%96-api) | ||
+ [5.10.1 .use()](#5101-use) | ||
+ [5.10.2 .type](#5102-type) | ||
+ [5.10.3 .check](#5103-check) | ||
+ [5.10.4 .version](#5104-version) | ||
+ [5.10.5 .plugins](#5105-plugins) | ||
* [5.9 偏旁部首功能](#59-%E5%81%8F%E6%97%81%E9%83%A8%E9%A6%96%E5%8A%9F%E8%83%BD) | ||
* [5.10 汉字、拼音工具方法](#510-%E6%B1%89%E5%AD%97%E6%8B%BC%E9%9F%B3%E5%B7%A5%E5%85%B7%E6%96%B9%E6%B3%95) | ||
+ [5.10.1 查询拼音详细信息: spellInfo](#5101-%E6%9F%A5%E8%AF%A2%E6%8B%BC%E9%9F%B3%E8%AF%A6%E7%BB%86%E4%BF%A1%E6%81%AF-spellinfo) | ||
+ [5.10.2 拼音音调操作: transformTone](#5102-%E6%8B%BC%E9%9F%B3%E9%9F%B3%E8%B0%83%E6%93%8D%E4%BD%9C-transformtone) | ||
+ [5.10.3 是否是汉字: isCnChar](#5103-%E6%98%AF%E5%90%A6%E6%98%AF%E6%B1%89%E5%AD%97-iscnchar) | ||
+ [5.10.4 比较拼音(汉字)大小: compareSpell](#5104-%E6%AF%94%E8%BE%83%E6%8B%BC%E9%9F%B3%E6%B1%89%E5%AD%97%E5%A4%A7%E5%B0%8F-comparespell) | ||
+ [5.10.5 比较汉字笔画数大小: compareStroke](#5105-%E6%AF%94%E8%BE%83%E6%B1%89%E5%AD%97%E7%AC%94%E7%94%BB%E6%95%B0%E5%A4%A7%E5%B0%8F-comparestroke) | ||
+ [5.10.6 根据拼音排序: sortSpell](#5106-%E6%A0%B9%E6%8D%AE%E6%8B%BC%E9%9F%B3%E6%8E%92%E5%BA%8F-sortspell) | ||
+ [5.10.7 根据笔画数排序: sortStroke](#5107-%E6%A0%B9%E6%8D%AE%E7%AC%94%E7%94%BB%E6%95%B0%E6%8E%92%E5%BA%8F-sortstroke) | ||
* [5.11 其他 api](#511-%E5%85%B6%E4%BB%96-api) | ||
+ [5.11.1 .use()](#5111-use) | ||
+ [5.11.2 .type](#5112-type) | ||
+ [5.11.3 .check](#5113-check) | ||
+ [5.11.4 .version](#5114-version) | ||
+ [5.11.5 .plugins](#5115-plugins) | ||
- [6.spell stroke 参数](#6spell-stroke-%E5%8F%82%E6%95%B0) | ||
@@ -80,20 +81,22 @@ * [6.1 spell 参数](#61-spell-%E5%8F%82%E6%95%B0) | ||
* [6.7 xhy 参数](#67-xhy-%E5%8F%82%E6%95%B0) | ||
* [6.8 使用实例大全:](#68-%E4%BD%BF%E7%94%A8%E5%AE%9E%E4%BE%8B%E5%A4%A7%E5%85%A8) | ||
+ [6.8.0 安装使用](#680-%E5%AE%89%E8%A3%85%E4%BD%BF%E7%94%A8) | ||
+ [6.8.1 cnchar 基础库功能](#681-cnchar-%E5%9F%BA%E7%A1%80%E5%BA%93%E5%8A%9F%E8%83%BD) | ||
+ [6.8.2 cnchar-poly 库功能](#682-cnchar-poly-%E5%BA%93%E5%8A%9F%E8%83%BD) | ||
+ [6.8.3 cnchar-order 库功能](#683-cnchar-order-%E5%BA%93%E5%8A%9F%E8%83%BD) | ||
+ [6.8.4 cnchar-trad 库功能](#684-cnchar-trad-%E5%BA%93%E5%8A%9F%E8%83%BD) | ||
- [6.8.4.1 convert 字体转换](#6841-convert-%E5%AD%97%E4%BD%93%E8%BD%AC%E6%8D%A2) | ||
- [6.8.4.2 spell 和 stroke 方法](#6842-spell-%E5%92%8C-stroke-%E6%96%B9%E6%B3%95) | ||
+ [6.8.5 cnchar-idiom 库功能](#685-cnchar-idiom-%E5%BA%93%E5%8A%9F%E8%83%BD) | ||
+ [6.8.6 cnchar-xhy 库功能](#686-cnchar-xhy-%E5%BA%93%E5%8A%9F%E8%83%BD) | ||
+ [6.8.7 工具方法](#687-%E5%B7%A5%E5%85%B7%E6%96%B9%E6%B3%95) | ||
- [6.8.7.1 spellInfo](#6871-spellinfo) | ||
- [6.8.7.2 isCnChar](#6872-iscnchar) | ||
- [6.8.7.3 transformTone](#6873-transformtone) | ||
- [6.8.7.4 compareSpell](#6874-comparespell) | ||
- [6.8.7.5 compareStroke](#6875-comparestroke) | ||
- [6.8.7.6 sortSpell](#6876-sortspell) | ||
- [6.8.7.7 sortStroke](#6877-sortstroke) | ||
* [6.8 radical 参数](#68-radical-%E5%8F%82%E6%95%B0) | ||
* [6.9 使用实例大全:](#69-%E4%BD%BF%E7%94%A8%E5%AE%9E%E4%BE%8B%E5%A4%A7%E5%85%A8) | ||
+ [6.9.0 安装使用](#690-%E5%AE%89%E8%A3%85%E4%BD%BF%E7%94%A8) | ||
+ [6.9.1 cnchar 基础库功能](#691-cnchar-%E5%9F%BA%E7%A1%80%E5%BA%93%E5%8A%9F%E8%83%BD) | ||
+ [6.9.2 cnchar-poly 库功能](#692-cnchar-poly-%E5%BA%93%E5%8A%9F%E8%83%BD) | ||
+ [6.9.3 cnchar-order 库功能](#693-cnchar-order-%E5%BA%93%E5%8A%9F%E8%83%BD) | ||
+ [6.9.4 cnchar-trad 库功能](#694-cnchar-trad-%E5%BA%93%E5%8A%9F%E8%83%BD) | ||
- [6.9.4.1 convert 字体转换](#6941-convert-%E5%AD%97%E4%BD%93%E8%BD%AC%E6%8D%A2) | ||
- [6.9.4.2 spell 和 stroke 方法](#6942-spell-%E5%92%8C-stroke-%E6%96%B9%E6%B3%95) | ||
+ [6.9.5 cnchar-idiom 库功能](#695-cnchar-idiom-%E5%BA%93%E5%8A%9F%E8%83%BD) | ||
+ [6.9.6 cnchar-xhy 库功能](#696-cnchar-xhy-%E5%BA%93%E5%8A%9F%E8%83%BD) | ||
+ [6.9.7 cnchar-radical 库功能](#697-cnchar-radical-%E5%BA%93%E5%8A%9F%E8%83%BD) | ||
+ [6.9.8 工具方法](#698-%E5%B7%A5%E5%85%B7%E6%96%B9%E6%B3%95) | ||
- [6.9.8.1 spellInfo](#6981-spellinfo) | ||
- [6.9.8.2 isCnChar](#6982-iscnchar) | ||
- [6.9.8.3 transformTone](#6983-transformtone) | ||
- [6.9.8.4 compareSpell](#6984-comparespell) | ||
- [6.9.8.5 compareStroke](#6985-comparestroke) | ||
- [6.9.8.6 sortSpell](#6986-sortspell) | ||
- [6.9.8.7 sortStroke](#6987-sortstroke) | ||
- [7.应用例子](#7%E5%BA%94%E7%94%A8%E4%BE%8B%E5%AD%90) | ||
@@ -167,7 +170,8 @@ | ||
14. 支持 **歇后语** 查询功能,支持模糊查询 | ||
15. 提供汉字工具方法,方便开发者更便捷高效地 **操作拼音和汉字** | ||
16. **体积小**,min 版本仅 46 kb,zip 版本 34 kb (含有大量汉字拼音字典) | ||
17. **多端可用**,可用于 **浏览器、nodejs、小程序/小游戏、ReactNative/Weex/Uniapp/Electron、webpack**...,支持所有 js 能运行的环境 | ||
18. **typescript支持**,支持在typescript中调用 | ||
19. 丰富的配置,按功能拆分成7个库按需取用 | ||
15. 支持 **偏旁部首** 查询功能 | ||
16. 提供汉字工具方法,方便开发者更便捷高效地 **操作拼音和汉字** | ||
17. **体积小**,min 版本仅 46 kb,zip 版本 34 kb (含有大量汉字拼音字典) | ||
18. **多端可用**,可用于 **浏览器、nodejs、小程序/小游戏、ReactNative/Weex/Uniapp/Electron、webpack**...,支持所有 js 能运行的环境 | ||
19. **typescript支持**,支持在typescript中调用 | ||
20. 丰富的配置,按功能拆分成7个库按需取用 | ||
@@ -187,2 +191,3 @@ ### 2.概览 | ||
| cnchar-xhy | 歇后语库 | 支持歇后语查询等功能 | 2.2+ | | ||
| cnchar-radical | 偏旁部首库 | 支持查询汉字偏旁部首 | 2.2.5+ | | ||
@@ -202,8 +207,8 @@ ### 3.安装 | ||
``` | ||
npm i cnchar-poly cnchar-order cnchar-trad cnchar-draw cnchar-idiom cnchar-xhy | ||
npm i cnchar-poly cnchar-order cnchar-trad cnchar-draw cnchar-idiom cnchar-xhy cnchar-radical | ||
``` | ||
当然您也可以按需安装其中的几个,但是 `cnchar` 这个基础库是必须安装的(draw、idiom、xhy三个库可以独立使用) | ||
当然您也可以按需安装其中的几个,但是 `cnchar` 这个基础库是必须安装的(draw、idiom、xhy、radical四个库可以独立使用) | ||
或者您可以通过安装`cnchar-all`来使用完整功能,这个库引用了上面的四个库 | ||
或者您可以通过安装`cnchar-all`来使用完整功能,这个库引用了上面的所有插件库 | ||
@@ -223,2 +228,3 @@ ``` | ||
<script src="https://cdn.jsdelivr.net/npm/cnchar-xhy/cnchar.xhy.min.js"></script> | ||
<script src="https://cdn.jsdelivr.net/npm/cnchar-radical/cnchar.radical.min.js"></script> | ||
``` | ||
@@ -247,2 +253,3 @@ | ||
import 'cnchar-xhy'; | ||
import 'cnchar-radical'; | ||
// 插件请按需取用 | ||
@@ -268,5 +275,6 @@ | ||
var xhy = require('cnchar-xhy'); | ||
var radical = require('cnchar-radical'); | ||
// 插件请按需取用 | ||
// 注:cnchar-draw 在非浏览器环境下不可使用 | ||
cnchar.use(poly, order, trad, idiom, xhy); | ||
cnchar.use(poly, order, trad, idiom, xhy, radical); | ||
@@ -291,2 +299,3 @@ console.log('汉字'.spell()); // prototype 方式调用 | ||
<script src="https://cdn.jsdelivr.net/npm/cnchar-xhy/cnchar.xhy.min.js"></script> | ||
<script src="https://cdn.jsdelivr.net/npm/cnchar-radical/cnchar.radical.min.js"></script> | ||
<script> | ||
@@ -577,2 +586,4 @@ console.log('汉字'.spell()); // prototype 方式调用 | ||
使用cdn引用时,会在window对向上暴露 `CncharIdiom` 对象 | ||
#### 5.8 歇后语功能 | ||
@@ -601,7 +612,34 @@ | ||
#### 5.9 汉字、拼音工具方法 | ||
使用cdn引用时,会在window对向上暴露 `CncharXHY` 对象 | ||
#### 5.9 偏旁部首功能 | ||
cnchar在 2.2.5 加入了偏旁部首功能,启用该功能需要安装 `cnchar-radical` 功能库,该库可以独立于cnchar主库运行 | ||
感谢 `kewell-tsao` 提供的 pr | ||
使用方式如下: | ||
```ts | ||
cnchar.radical(text:string | Array<string>, ...radicalArgs: Array<radicalArg>): string | Array<string>; | ||
``` | ||
看一个具体例子 | ||
```js | ||
cnchar.radical('你'); // "亻", | ||
cnchar.radical('你好呀'); // "亻女口" | ||
// 返回数组 | ||
cnchar.radical('你好呀', 'array'); // ["亻", "女", "口"] | ||
// 传入数组会默认返回数组 | ||
cnchar.radical(["你", "好", "呀"]); // ["亻", "女", "口"] | ||
``` | ||
使用cdn引用时,会在window对向上暴露 `CncharRadical` 对象 | ||
#### 5.10 汉字、拼音工具方法 | ||
cnchar 将库内部使用的一些操作拼音和汉字的方法整理暴露出来,方便开发者便捷高效的操作拼音和汉字 | ||
##### 5.9.1 查询拼音详细信息: spellInfo | ||
##### 5.10.1 查询拼音详细信息: spellInfo | ||
@@ -640,3 +678,3 @@ `spellInfo` 方法用于查询拼音的详细信息,用法如下: | ||
##### 5.9.2 拼音音调操作: transformTone | ||
##### 5.10.2 拼音音调操作: transformTone | ||
@@ -665,3 +703,3 @@ `transformTone` 方法用于将有音调拼音转换为无音调拼音,且可以获取音调位置和声调 | ||
##### 5.9.3 是否是汉字: isCnChar | ||
##### 5.10.3 是否是汉字: isCnChar | ||
@@ -674,3 +712,3 @@ `isCnChar` 方法用于判断一个字符是否是汉字 | ||
##### 5.9.4 比较拼音(汉字)大小: compareSpell | ||
##### 5.10.4 比较拼音(汉字)大小: compareSpell | ||
@@ -696,3 +734,3 @@ `compareSpell` 方法用于按照拼音比较拼音或汉字的大小,可用于通讯录姓名拼音排序等场景 | ||
##### 5.9.5 比较汉字笔画数大小: compareStroke | ||
##### 5.10.5 比较汉字笔画数大小: compareStroke | ||
@@ -717,3 +755,3 @@ `compareStroke` 方法用于按照笔画数比较汉字大小,可用于按照姓名首个汉字笔画排序等场景,排序可以参考 `sortStroke` 方法 | ||
##### 5.9.6 根据拼音排序: sortSpell | ||
##### 5.10.6 根据拼音排序: sortSpell | ||
@@ -740,3 +778,3 @@ `sortSpell` 方法用于按照拼音排序汉字或拼音,支持输入数组或字符串,支持按照声调排序、支持倒序 | ||
##### 5.9.7 根据笔画数排序: sortStroke | ||
##### 5.10.7 根据笔画数排序: sortStroke | ||
@@ -763,5 +801,5 @@ `sortStroke` 方法用于按照笔画数排序汉字 | ||
#### 5.10 其他 api | ||
#### 5.11 其他 api | ||
##### 5.10.1 .use() | ||
##### 5.11.1 .use() | ||
@@ -795,5 +833,5 @@ 这个 api 的功能是显式启用 `poly`、`order`、`trad` 三个功能库 | ||
##### 5.10.2 .type | ||
##### 5.11.2 .type | ||
type 对象用户获取当前可用的 `spell` 、 `stroke` 、 `orderToWord` 、`spellToWord`、`strokeToWord` 参数类型: | ||
type 对象用户获取当前可用的 `spell` 、 `stroke` 、 `orderToWord` 、`spellToWord`、`strokeToWord`、`idiom`、 `xhy`、`radical` 参数类型: | ||
@@ -806,2 +844,5 @@ ```js | ||
var strokeToWordArg = cnchar.type.strokeToWord; | ||
var idiomArg = cnchar.type.idiom; | ||
var xhyArg = cnchar.type.xhy; | ||
var radicalArg = cnchar.type.radical; | ||
``` | ||
@@ -819,5 +860,13 @@ | ||
idiomArg 最多可用值: `['char','stroke','spell','tone']` | ||
xhyArg 最多可用值: `['fuzzy','answer','second']` | ||
radicalArg 最多可用值: `['array']` | ||
以上值皆为 json | ||
具体用法<a href="#user-content-6-spell-stroke-参数">第六章</a>讲到 | ||
##### 5.10.3 .check | ||
##### 5.11.3 .check | ||
@@ -832,3 +881,3 @@ 该值是一个 布尔类型,用于控制是否开启参数校验,默认值为 true | ||
##### 5.10.4 .version | ||
##### 5.11.4 .version | ||
@@ -841,3 +890,3 @@ 获取当前版本: | ||
##### 5.10.5 .plugins | ||
##### 5.11.5 .plugins | ||
@@ -991,6 +1040,18 @@ 当前使用的功能库列表,最多的情况为 `["order", "trad", "poly"]` | ||
#### 6.8 使用实例大全: | ||
#### 6.8 radical 参数 | ||
##### 6.8.0 安装使用 | ||
参数调用如下,value表示需要查询偏旁的汉字,可以是字符串或数组 | ||
```js | ||
cnchar.radical(value,arg1,arg2,...); | ||
``` | ||
| 参数 | 作用 | 是否默认 | 依赖库 | 备注 | | ||
| :-----: | :----: | :------: | :---: | :---: | | ||
| array | 是否返回数组 | 否 | -- | 当传入为数组时默认返回数组 | | ||
#### 6.9 使用实例大全: | ||
##### 6.9.0 安装使用 | ||
npm 方式 | ||
@@ -1016,3 +1077,3 @@ | ||
##### 6.8.1 cnchar 基础库功能 | ||
##### 6.9.1 cnchar 基础库功能 | ||
@@ -1052,3 +1113,3 @@ ```js | ||
##### 6.8.2 cnchar-poly 库功能 | ||
##### 6.9.2 cnchar-poly 库功能 | ||
@@ -1063,3 +1124,3 @@ 该库用于准确识别多音词,同样支持 6.3.1 中的其他参数功能 | ||
##### 6.8.3 cnchar-order 库功能 | ||
##### 6.9.3 cnchar-order 库功能 | ||
@@ -1120,7 +1181,7 @@ 该库用于查询汉字笔画顺序、笔画名称等,返回值为 数组 | ||
##### 6.8.4 cnchar-trad 库功能 | ||
##### 6.9.4 cnchar-trad 库功能 | ||
该库用于支持繁体字火星文转换及为拼音笔画数等基本功能提供繁体字支持 | ||
###### 6.8.4.1 convert 字体转换 | ||
###### 6.9.4.1 convert 字体转换 | ||
@@ -1147,3 +1208,3 @@ ```js | ||
###### 6.8.4.2 spell 和 stroke 方法 | ||
###### 6.9.4.2 spell 和 stroke 方法 | ||
@@ -1164,3 +1225,3 @@ 该库增加了对于繁体字的拼音笔画功能扩展,其他基础用法与 基础库一致: | ||
##### 6.8.5 cnchar-idiom 库功能 | ||
##### 6.9.5 cnchar-idiom 库功能 | ||
@@ -1176,3 +1237,3 @@ 该库为cnchar扩展了成语功能 | ||
##### 6.8.6 cnchar-xhy 库功能 | ||
##### 6.9.6 cnchar-xhy 库功能 | ||
@@ -1188,7 +1249,18 @@ 该库为cnchar扩展了歇后语功能 | ||
##### 6.8.7 工具方法 | ||
##### 6.9.7 cnchar-radical 库功能 | ||
该库为cnchar扩展了偏旁部首功能 | ||
```js | ||
cnchar.radical('你'); // "亻", | ||
cnchar.radical('你好呀'); // "亻女口" | ||
cnchar.radical('你好呀', 'array'); // ["亻", "女", "口"] | ||
cnchar.radical(["你", "好", "呀"]); // ["亻", "女", "口"] | ||
``` | ||
##### 6.9.8 工具方法 | ||
cnchar提供了一些汉字工具方法,方便开发者更便捷高效地操作拼音和汉字 | ||
###### 6.8.7.1 spellInfo | ||
###### 6.9.8.1 spellInfo | ||
@@ -1200,3 +1272,3 @@ ```js | ||
###### 6.8.7.2 isCnChar | ||
###### 6.9.8.2 isCnChar | ||
@@ -1211,3 +1283,3 @@ ```js | ||
###### 6.8.7.3 transformTone | ||
###### 6.9.8.3 transformTone | ||
@@ -1221,3 +1293,3 @@ ```js | ||
###### 6.8.7.4 compareSpell | ||
###### 6.9.8.4 compareSpell | ||
@@ -1234,3 +1306,3 @@ ```js | ||
###### 6.8.7.5 compareStroke | ||
###### 6.9.8.5 compareStroke | ||
@@ -1245,3 +1317,3 @@ ```js | ||
###### 6.8.7.6 sortSpell | ||
###### 6.9.8.6 sortSpell | ||
@@ -1257,3 +1329,3 @@ ```js | ||
###### 6.8.7.7 sortStroke | ||
###### 6.9.8.7 sortStroke | ||
@@ -1260,0 +1332,0 @@ ```js |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
201031
1308