Cnchar

<p align="center"> <img src='https://fastly.jsdelivr.net/gh/theajack/cnchar/dist/rm-logo.png' width='200px'/> </p> <p align="center"> <a href="https://www.github.com/theajack/cnchar/stargazers" target="_black"> <img src="https://img.shields.io/github/stars/theajack/cnchar?logo=github" alt="stars" /> </a> <a href="https://www.github.com/theajack/cnchar/network/members" target="_black"> <img src="https://img.shields.io/github/forks/theajack/cnchar?logo=github" alt="forks" /> </a> <a href="https://www.npmjs.com/package/cnchar" target="_black"> <img src="https://img.shields.io/npm/v/cnchar?logo=npm" alt="version" /> </a> <a href="https://www.npmjs.com/package/cnchar" target="_black"> <img src="https://img.shields.io/npm/dm/cnchar?color=%23ffca28&logo=npm" alt="downloads" /> </a> <a href="https://www.jsdelivr.com/package/npm/cnchar" target="_black"> <img src="https://data.jsdelivr.com/v1/package/npm/cnchar/badge" alt="jsdelivr" /> </a> </p> <p align="center"> <a href="https://github.com/theajack" target="_black"> <img src="https://img.shields.io/badge/Author-%20theajack%20-7289da.svg?&logo=github" alt="author" /> </a> <a href="https://www.github.com/theajack/cnchar/blob/master/LICENSE" target="_black"> <img src="https://img.shields.io/github/license/theajack/cnchar?color=%232DCE89&logo=github" alt="license" /> </a> <a href="https://fastly.jsdelivr.net/gh/theajack/cnchar/dist/cnchar.latest.min.js"><img src="https://img.shields.io/bundlephobia/minzip/cnchar.svg" alt="Size"></a> <a href="https://github.com/theajack/cnchar/search?l=javascript"><img src="https://img.shields.io/github/languages/top/theajack/cnchar.svg" alt="TopLang"></a> <a href="https://github.com/theajack/cnchar/issues"><img src="https://img.shields.io/github/issues-closed/theajack/cnchar.svg" alt="issue"></a> <a href="https://www.github.com/theajack/cnchar"><img src="https://img.shields.io/librariesio/dependent-repos/npm/cnchar.svg" alt="Dependent"></a> </p> <h3>🚀 功能全面、多端支持的汉字拼音笔画 js 库</h3>

English | 在线试用/文档 | 更新日志 | 反馈错误/缺漏 | Gitee | QQ Group: 958278438 | 留言板

Sponsors

<p align="center"> <a href="https://alinsjs.github.io/docs"> <img width="75" src="https://shiyix.cn/images/alins.png" alt="alins"> </a> <a style="margin-left: 10px" href="https://github.com/lim-f/react-lim"> <img width="80" src="https://shiyix.cn/images/react.svg" alt="alins"> </a> <a style="margin-left: 10px" href="https://github.com/lim-f/vue-lim"> <img width="80" src="https://shiyix.cn/images/vue.svg" alt="alins"> </a> </p>

---

应用例子

开始文档之前，先通过一些应用案例看看 cnchar 能够做些什么

汉字打字游戏 | 打字弹钢琴 | 成语接龙 | 通讯录排序 | 取名字 | 输入法 | 歇后语 | 语音识别与合成 | 简繁体转换

---

<details> <summary>展开目录</summary> <!-- toc -->

• Sponsors
  • 应用例子
  • 前言
  • 0.快速使用
  • 1.功能
  • 2.功能及插件概览
  • 3.安装
    • 3.1 使用 npm 安装
    • 3.2 cdn 引入
  • 4.使用
    • 4.1 webpack浏览器环境(有window对象)
    • 4.2 nodejs 等非浏览器环境
    • 4.3 原生浏览器环境
  • 5.API
    • 5.1 拼音笔画基础 API: spell & stroke
    • 5.2 可视化绘制汉字: draw
      • 5.2.1 使用
      • 5.2.2 参数
      • 5.2.3 绘制控制api
        • 5.2.3.1 startAnimation
        • 5.2.3.2 pauseAnimation & resumeAnimation
        • 5.2.3.3 drawNextStroke
      • 5.2.4 微信小程序中使用
      • 5.2.5 其他api
    • 5.3 繁体、简体、火星文互转: convert
    • 5.4 笔画序列推出原汉字: orderToWord
    • 5.5 通过拼音查询原汉字: spellToWord
    • 5.6 通过笔画数查询原汉字: strokeToWord
    • 5.7 成语功能
    • 5.8 歇后语功能
    • 5.9 偏旁部首功能
    • 5.10 组词功能
    • 5.11 查询解释功能
    • 5.12 发音、语音合成和语音识别
      • 5.12.1 voice api
      • 5.12.2 speak api
      • 5.12.2 regonize api
    • 5.13 汉字、拼音工具方法
      • 5.13.1 查询拼音详细信息: spellInfo
      • 5.13.2 拼音音调操作: transformTone
      • 5.13.3 是否是汉字: isCnChar
      • 5.13.4 是否是多音字: isPolyWord
      • 5.13.5 比较拼音（汉字）大小: compareSpell
      • 5.13.6 比较汉字笔画数大小: compareStroke
      • 5.13.7 根据拼音排序: sortSpell
      • 5.13.8 根据笔画数排序: sortStroke
      • 5.13.9 将数字表示的声调转为拼音声调: shapeSpell
      • 5.13.10 判断拼音是否有音调: hasTone
    • 5.14 自定义数据
      • 5.14.1 setSpell
      • 5.14.2 setSpellDefault
      • 5.14.3 setStrokeCount
      • 5.14.4 setPolyPhrase
      • 5.14.5 setOrder
      • 5.14.6 setRadical
      • 5.14.7 addXhy
      • 5.14.8 addWords
      • 5.14.9 addExplain
      • 5.14.10 addVoice
    • 5.15 其他 api
      • 5.15.1 .use()
      • 5.15.2 .type
      • 5.15.3 .check
      • 5.15.4 .version & env
      • 5.15.5 .plugins
    • 5.16 离线使用
    • 5.17 自定义插件
      • 5.17.1 pluginName属性
      • 5.17.2 install属性
      • 5.17.3 getCnChar
      • 5.17.4 js定义插件
      • 5.17.5 ts定义插件
  • 6.参数介绍
    • 6.1 spell 参数
    • 6.2 stroke 参数
    • 6.3 orderToWord 参数
    • 6.4 spellToWord 参数
    • 6.5 strokeToWord 参数
    • 6.6 idiom 参数
    • 6.7 xhy 参数
    • 6.8 radical 参数
    • 6.9 words 与 explain 参数
    • 6.10 使用实例大全：
      • 6.10.0 安装使用
      • 6.10.1 cnchar 基础库功能
      • 6.10.2 cnchar-poly 库功能
      • 6.10.3 cnchar-order 库功能
      • 6.10.4 cnchar-trad 库功能
        • 6.10.4.1 convert 字体转换
        • 6.10.4.2 spell 和 stroke 方法
      • 6.10.5 cnchar-idiom 库功能
      • 6.10.6 cnchar-xhy 库功能
      • 6.10.7 cnchar-radical 库功能
      • 6.10.8 cnchar-words
      • 6.10.8 cnchar-explain
      • 6.10.10 cnchar-voice
      • 6.10.11 工具方法
        • 6.10.11.1 spellInfo
        • 6.10.11.2 isCnChar
        • 6.10.11.3 transformTone
        • 6.10.11.4 compareSpell
        • 6.10.11.5 compareStroke
        • 6.10.11.6 sortSpell
        • 6.10.11.7 sortStroke
        • 6.10.11.8 isPolyWord
        • 6.10.11.9 shapeSpell
        • 6.10.11.10 setSpell
        • 6.10.11.11 setSpellDefault
        • 6.10.11.12 setStrokeCount
        • 6.10.11.13 setOrder
        • 6.10.11.14 setPolyPhrase
        • 6.10.11.15 setRadical
        • 6.10.11.16 addXhy

<!-- tocstop --> </details>

---

前言

感谢同学们对于 cnchar 的支持，由于 cnchar 词库来源于网络，虽然经过了本人的修改和扩充，但是还是难免有错误与缺漏之处，希望大家可以将使用中发现的错误与缺漏之处 反馈 给我（或自行修改提交，经过审查无误过后会合到 cnchar 中）

我要反馈错误或缺漏

关于该文档

由于文档较长，做一下简介，请按照需要阅读

• 第零章可以帮助开发者快速接入cnchar
• 第一、二章介绍了cnchar的功能及其功能库
• 第三章介绍了cnchar的安装和使用
• 第四章介绍了各种不同环境下cnchar的使用差异
• 第五章详细介绍了cnchar及其功能库的API使用
• 第六章列举了各个方法的参数和大量的cnchar使用实例

另外，由于插件较多，编写文档工作量巨大，如有遗漏请参考 cnchar-types 定义。也欢迎大家一起帮忙完善文档

0.快速使用

使用 npm 安装：

npm i cnchar

import cnchar from 'cnchar';
'汉字'.spell();
'汉字'.stroke();

使用 script 标签使用：

如果 jsdelivr 挂了可以使用 unpkg (https://unpkg.com/cnchar/cnchar.min.js)

<script src="https://fastly.jsdelivr.net/npm/cnchar/cnchar.min.js"></script>
<script>
    '汉字'.spell();
    '汉字'.stroke();
</script>