feat: 2.2.5 偏旁部首库

theajack · Sep 8, 2020 · 3d2e618 · 3d2e618
1 parent 7c0f09a
commit 3d2e618
Show file tree

Hide file tree

Showing 97 changed files with 10,602 additions and 799 deletions.
diff --git a/README.md b/README.md
diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js
@@ -28,6 +28,7 @@ module.exports = {
                     {text: 'cnchar-draw: 汉字可视化', link: '/doc/draw'},
                     {text: 'cnchar-idiom: 成语', link: '/doc/idiom'},
                     {text: 'cnchar-xhy: 歇后语', link: '/doc/xhy'},
+                    {text: 'cnchar-radical: 偏旁部首', link: '/doc/radical'},
                     {text: '工具方法', link: '/doc/tool'},
                 ],
             },
@@ -81,6 +82,10 @@ module.exports = {
                             title: 'cnchar-xhy',
                             path: 'xhy',
                         },
+                        {
+                            title: 'cnchar-radical',
+                            path: 'radical',
+                        },
                         {
                             title: '工具方法',
                             path: 'tool',

diff --git a/docs/doc/idiom.md b/docs/doc/idiom.md
@@ -22,6 +22,8 @@ cnchar.idiom('shang', 'spell'); // ["伤风败化", "伤风败俗", ...]
 cnchar.idiom('shang4', 'spell', 'tone'); // ["上兵伐谋", "上不着天，下不着地", ... ]
 ```
 
+使用cdn引用时，会在window对向上暴露 `CncharIdiom` 对象
+
 ## 2. idiom 参数
 
 参数调用如下，value表示查询对象，可以试拼音汉字笔画数，所有 arg 参数都是可选的

diff --git a/docs/doc/radical.md b/docs/doc/radical.md
@@ -0,0 +1,48 @@
+## 1. 介绍
+
+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` 对象
+
+## 2. radical 参数
+
+参数调用如下，value表示需要查询偏旁的汉字，可以是字符串或数组
+
+```js
+cnchar.radical(value,arg1,arg2,...);
+```
+
+|  参数   |    作用    | 是否默认 |  依赖库   |   备注    |
+| :-----: | :----: | :------: | :---: | :---: |
+|  array   | 是否返回数组 |    否    | -- |  当传入为数组时默认返回数组  |
+
+## 3. 实例
+
+
+该库为cnchar扩展了偏旁部首功能
+
+```js
+cnchar.radical('你'); // "亻",
+cnchar.radical('你好呀'); // "亻女口"
+cnchar.radical('你好呀', 'array'); // ["亻", "女", "口"]
+cnchar.radical(["你", "好", "呀"]); // ["亻", "女", "口"]
+```
diff --git a/docs/doc/xhy.md b/docs/doc/xhy.md
@@ -22,6 +22,8 @@ cnchar.xhy('大水', 'fuzzy', 'answer');  // ['泥沙俱下', '后浪推前浪',
 cnchar.xhy('上晃下摇', 'fuzzy', 'answer', 'second'); // ['醉汉过铁索桥', '扶着醉汉过破桥']
 ```
 
+使用cdn引用时，会在window对向上暴露 `CncharXHY` 对象
+
 ## 2. xhy 参数
 
 参数调用如下，value表示歇后语查询对象，可以是歇后语的第一句或第二句，所有 arg 参数都是可选的

diff --git a/docs/guide/README.md b/docs/guide/README.md
@@ -46,11 +46,12 @@ sidebarDepth: 0  //吐槽：这里设置0无效！只能设置1或2！
 12. 支持 **繁体字** 拼音、笔画数及以上所有功能，实现和简体字一样的功能
 13. 支持 **成语** 查询功能，可以按照汉字、拼音（声调）、笔画数查询成语
 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个库按需取用
 
 
 ## 3. 概览
@@ -66,6 +67,7 @@ sidebarDepth: 0  //吐槽：这里设置0无效！只能设置1或2！
 | [cnchar-draw](/cnchar/v2/doc/draw)  |    绘制笔画库    | 支持可视化绘制汉字，有 normal,animation,stroke,test 四种模式可选，该库仅在浏览器环境下可用 | 2.1+ |
 | [cnchar-idiom](/cnchar/v2/doc/idiom)   |    成语库    | 支持成语查询等功能 | 2.2+ |
 | [cnchar-xhy](/cnchar/v2/doc/xhy)   |    歇后语库    | 支持歇后语查询等功能 | 2.2+ |
+| [cnchar-radical](/cnchar/v2/doc/radical)   |    偏旁部首库    | 支持查询汉字偏旁部首 | 2.2.5+ |
 
 <div>
     <star></star>

diff --git a/docs/guide/start.md b/docs/guide/start.md
@@ -1,7 +1,7 @@
 
 ## 1. npm安装
 
-cnchar包含了一个基本库和六个功能库，用于实现不同的功能，您可以按需安装其中的功能库，但是 `cnchar` 这个基础库是必须安装的（draw、idiom、xhy三个库可以独立使用）
+cnchar包含了一个基本库和六个功能库，用于实现不同的功能，您可以按需安装其中的功能库，但是 `cnchar` 这个基础库是必须安装的（draw、idiom、xhy、radical四个库可以独立使用）
 
 安装[主库](https://npmjs.com/package/cnchar)：
 
@@ -15,7 +15,7 @@ npm i cnchar
 
 <div>
   <highlight-code>
-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
   </highlight-code>
 </div>
 
@@ -31,6 +31,7 @@ npm i cnchar-poly cnchar-order cnchar-trad cnchar-draw cnchar-idiom cnchar-xhy
     import 'cnchar-draw';
     import 'cnchar-idiom';
     import 'cnchar-xhy';
+    import 'cnchar-radical';
   </highlight-code>
 </div>
 
@@ -45,7 +46,8 @@ npm i cnchar-poly cnchar-order cnchar-trad cnchar-draw cnchar-idiom cnchar-xhy
     import trad from 'cnchar-trad';
     import idiom from 'cnchar-idiom';
     import xhy from 'cnchar-xhy';
-    cnchar.use(poly, order, trad, idiom, xhy);
+    import radical from 'cnchar-radical';
+    cnchar.use(poly, order, trad, idiom, xhy, radical);
   </highlight-code>
 </div>
 
@@ -60,7 +62,8 @@ commonjs 模块
     var trad = require('cnchar-trad');
     var idiom = require('cnchar-idiom');
     var xhy = require('cnchar-xhy');
-    cnchar.use(poly, order, trad, idiom, xhy);
+    var radical = require('cnchar-radical');
+    cnchar.use(poly, order, trad, idiom, xhy, radical);
   </highlight-code>
 </div>
 
@@ -77,6 +80,7 @@ commonjs 模块
       &lt;script src="https://cdn.jsdelivr.net/npm/cnchar-trad/cnchar.trad.min.js">&lt;/script>
       &lt;script src="https://cdn.jsdelivr.net/npm/cnchar-draw/cnchar.draw.min.js">&lt;/script>
       &lt;script src="https://cdn.jsdelivr.net/npm/cnchar-idiom/cnchar.idiom.min.js"> &lt;/script>
+      &lt;script src="https://cdn.jsdelivr.net/npm/cnchar-radical/cnchar.radical.min.js"> &lt;/script>
       &lt;script src="https://cdn.jsdelivr.net/npm/cnchar-xhy/cnchar.xhy.min.js"> &lt;/script>
   </highlight-code>
 </div>

diff --git a/docs/guide/version.md b/docs/guide/version.md
@@ -80,12 +80,29 @@
 1. 修复cnchar-all及cnchar-draw库在非浏览器环境会报错的bug
 2. 修复 draw库和main库在ts环境中引用的异常
 
-## 2.2.0 [2020/6/4]
+## 2.2.0
 1. 增加cnchar-idiom 成语库
 2. 增加cnchar-xhy 歇后语库
 3. 增加transformTone,isCnchar,compareSpell,compareStroke,sortSpell,sortStroke工具方法，方便开发者更便捷的操作拼音和汉字
 4. 对ts声明文件进行修改，对ts的支持更加友好
 5. 鸟字增加默认读音
 6. 彷徨读音修正
 7. cnchar-draw 增加 Promise-polyfill
-8. 文档增加Object.assign-polyfill
+8. 文档增加Object.assign-polyfill
+
+## 2.2.1
+1. 修复ts声明文件的bug
+2. ts声明文件增加字符串扩展方法
+3. 修复构建npm的bug
+
+## 2.2.2
+1. 增加几个多音字的默认读音
+
+## 2.2.3
+1. 修复draw库不同绘制实例样式会干扰的bug
+
+## 2.2.4
+1. 增加 红 字的默认读音
+
+## 2.2.5
+1. 增加cnchar-radical, 偏旁部首插件库
diff --git a/docs/v2/assets/js/10.6fe8a37b.js → docs/v2/assets/js/10.35940bd6.js b/docs/v2/assets/js/10.6fe8a37b.js → docs/v2/assets/js/10.35940bd6.js