🚀 功能全面、多端支持的汉字拼音笔画 js 库

Sponsors

应用例子

前言

0.快速使用

npm i cnchar

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

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

1.功能

2.功能及插件概览

3.安装

3.1 使用 npm 安装

npm i cnchar

npm i cnchar-poly cnchar-order cnchar-trad cnchar-draw cnchar-idiom cnchar-xhy cnchar-radical cnchar-words cnchar-explain cnchar-voice cnchar-random cnchar-code cnchar-input cnchar-info cnchar-name

npm i cnchar-all

3.2 cdn 引入

<script src="https://fastly.jsdelivr.net/npm/cnchar/cnchar.min.js"></script>
<script src="https://fastly.jsdelivr.net/npm/cnchar-poly/cnchar.poly.min.js"></script>
<script src="https://fastly.jsdelivr.net/npm/cnchar-order/cnchar.order.min.js"></script>
<script src="https://fastly.jsdelivr.net/npm/cnchar-trad/cnchar.trad.min.js"></script>
<script src="https://fastly.jsdelivr.net/npm/cnchar-draw/cnchar.draw.min.js"></script>
<script src="https://fastly.jsdelivr.net/npm/cnchar-idiom/cnchar.idiom.min.js"></script>
<script src="https://fastly.jsdelivr.net/npm/cnchar-xhy/cnchar.xhy.min.js"></script>
<script src="https://fastly.jsdelivr.net/npm/cnchar-radical/cnchar.radical.min.js"></script>
<script src="https://fastly.jsdelivr.net/npm/cnchar-words/cnchar.words.min.js"></script>
<script src="https://fastly.jsdelivr.net/npm/cnchar-explain/cnchar.explain.min.js"></script>
<script src="https://fastly.jsdelivr.net/npm/cnchar-voice/cnchar.voice.min.js"></script>
<script src="https://fastly.jsdelivr.net/npm/cnchar-random/cnchar.random.min.js"></script>
<script src="https://fastly.jsdelivr.net/npm/cnchar-code/cnchar.code.min.js"></script>
<script src="https://fastly.jsdelivr.net/npm/cnchar-input/cnchar.input.min.js"></script>
<script src="https://fastly.jsdelivr.net/npm/cnchar-info/cnchar.info.min.js"></script>
<script src="https://fastly.jsdelivr.net/npm/cnchar-name/cnchar.name.min.js"></script>

<script src="https://fastly.jsdelivr.net/npm/cnchar-all/cnchar.all.min.js"></script>

4.使用

4.1 webpack浏览器环境(有window对象)

// 请保证最先引入 cnchar 基础库,其他几个库顺序无所谓
import cnchar from 'cnchar';
import 'cnchar-poly';
// ... 其他插件请参考第二章 2. 功能及插件概览
// 插件请按需取用
console.log('汉字'.spell()); // prototype 方式调用
console.log(cnchar.spell('汉字')); // cnchar api 调用

4.2 nodejs 等非浏览器环境

// 请保证最先引入 cnchar 基础库,其他几个库顺序无所谓
var cnchar = require('cnchar');
var poly = require('cnchar-poly');
// ... 其他插件请参考第二章 2. 功能及插件概览
// 插件请按需取用
// 注:cnchar-draw,cnchar-voice 在非浏览器环境下不可使用
cnchar.use(poly);
console.log('汉字'.spell()); // prototype 方式调用
console.log(cnchar.spell('汉字')); // cnchar api 调用

4.3 原生浏览器环境

<script src="https://fastly.jsdelivr.net/npm/cnchar/cnchar.min.js"></script>
<script src="https://fastly.jsdelivr.net/npm/cnchar-poly/cnchar.poly.min.js"></script>
<!--... 其他插件请参考第二章 2. 功能及插件概览-->
<script>
 console.log('汉字'.spell()); // prototype 方式调用
 console.log(cnchar.spell('汉字')); // cnchar api 调用
</script>

5.API

5.1 拼音笔画基础 API: spell & stroke

// 获取汉字的拼音、多音词、音调等都集成在以下方法上
cnchar.spell(string[,...args]);
// 或
string.spell([...args])
// 获取汉字的笔画、笔画顺序等都集成在以下方法上
cnchar.stroke(string[,...args]);
// 或
string.stroke([...args])

5.2 可视化绘制汉字: draw

5.2.1 使用

cnchar.draw('你好', options); // options 为可选参数, 在5.2.2 种会详细介绍

import draw from 'cnchar-draw';
draw('你好')

5.2.2 参数

declare interface DrawOption {
 el?: string | HTMLElement; // 绘制的容器,支持选择器或dom,若是不填,会在body后append一个dom作为容器
 type?: DrawType; // 绘制模式,默认为normal
 clear?: boolean; // 绘制前是否清空容器 默认为true
 style?: { // 样式类
 backgroundColor?: string, // 默认为#fff
 showOutline?: boolean;//: true,
 showCharacter?: boolean;//: true,
 currentColor?: string;//: '#b44', // 仅在stroke模式下有效
 length?: number;//: 60,
 padding?: number;//: 5, // 数值, 默认 20。 画布的汉字和边缘之间的填充
 outlineColor?: string;//: '#ddd', // 十六进制字符, 默认 '#DDD'。
 strokeColor?: string;//: '#555', // 十六进制字符, 默认 '#555'。绘制每个笔划的颜色。
 radicalColor?: string;//: null, // 十六进制字符, 默认 null。 如果存在偏旁部首数据,则在笔划中绘制偏旁部首的颜色。 如果没有设置,激光将绘制与其他笔划相同的颜色。
 strokeFadeDuration?: number; //400
 },
 line?: { // 背景线条类
 lineStraight?: boolean;// : true,
 lineCross?: boolean;// : true,
 lineWidth?: number;// : 1,
 lineColor?: string;// : '#ddd',
 lineDash?: boolean;// : true,
 border?: boolean;// : true,
 borderWidth?: number;// : 1,
 borderColor?: string;// : '#ccc',
 borderDash?: boolean;// : false,
 },
 animation?: {
 strokeAnimationSpeed?: number;// : 1, // 数值, 默认 1。 绘制每个笔划的速度必须大于0。增加此数字可以更快地绘制笔划,减少绘制笔划的速度更慢。
 delayBetweenStrokes?: number;// : 1000, // 数值, 默认 1000。 动画进行中每个笔画之间的间隔时间(以毫秒为单位)。
 delayBetweenLoops?: number;// : 200, // 数值, 默认 2000。 循环动画时每个动画循环之间的时间(以毫秒为单位)。
 autoAnimate?: boolean;// : true,
 animateComplete?: Function;// : () => {},
 stepByStep?: boolean;// : true,
 loopAnimate?: boolean;// : false,
 },
 test?: {
 strokeHighlightSpeed?: number;// : 20, // 数值, 默认 20。 在测验中给出提示时突出显示每个笔划的速度必须大于0。增加此数字以突出显示更快,减少以突出显示更慢。
 highlightColor?: number;// : '#aaf', // 十六进制字符, 默认 '#AAF'。 用于在测验中突出显示的颜色。
 drawingColor?: number;// : '#333', // 十六进制字符, 默认 '#333'。 测验期间绘制的线条颜色。
 drawingWidth?: number;// : 4, // 数值, 默认 4。 进行测验时绘制的线条宽度。
 showHintAfterMisses?: number;// : 3, // 整数, 默认 3 中风高亮提示之前的未命中数被给予用户。 设置为 false 以禁用。 创建测验时也可以设置此项。
 highlightOnComplete?: number;// : true, // 布尔值, 默认 true。 控制当用户完成绘制整个字符时,测验是否会短暂突出显示字符。 创建测验时也可以设置此项。
 highlightCompleteColor?: number;// : null, // 十六进制字符, 默认 null。 在测验中突出显示字符时使用的颜色。 如果未设置,则将使用highlightColor。 仅当highlightOnComplete为true时才相关。
 onTestStatus?(args: TestStatus):void;// : null, // ({index, status, data})=>{}
 }
};

5.2.3 绘制控制api

declare interface IWriter {
 option: IDrawOption;
 el: HTMLElement;
 type: TDrawType;
 text: Array<string>;
 writers: Array<HanziWriter>;
 startAnimation(): boolean;
 pauseAnimation(): void;
 resumeAnimation(): void;
 drawNextStroke(onComplete?: ()=>void): boolean;
}

5.2.3.1 startAnimation

const writer = cnchar.draw('你好', {
 type: cnchar.draw.TYPE.ANIMATION,
 animation: {
 autoAnimate: false,
 }
});
writer.startAnimation();

5.2.3.2 pauseAnimation & resumeAnimation

const writer = cnchar.draw('你好', {
 type: cnchar.draw.TYPE.ANIMATION
});
writer.pauseAnimation();
writer.resumeAnimation();

5.2.3.3 drawNextStroke

const writer = cnchar.draw('你好', {
 type: cnchar.draw.TYPE.ANIMATION,
 animation: {
 autoAnimate: false,
 }
});
writer.drawNextStroke(()=>{
 // 当前笔画绘制完成的回调
});

5.2.4 微信小程序中使用

5.2.5 其他api

cnchar.draw.onWordNotFound(word=>{
 console.log(word);
});

5.3 繁体、简体、火星文互转: convert

cnchar.convert.simpleToTrad(string); // 简体 => 繁体
cnchar.convert.simpleToSpark(string); // 简体 => 火星文
cnchar.convert.tradToSimple(string); // 繁体 => 简体
cnchar.convert.tradToSpark(string); // 繁体 => 火星文
cnchar.convert.sparkToSimple(string); // 火星文 => 简体
cnchar.convert.sparkToTrad(string); // 火星文 => 繁体
string.convertSimpleToTrad();
string.convertSimpleToSpark();
string.convertTradToSimple();
string.convertTradToSpark();
string.convertSparkToSimple();
string.convertSparkToTrad();

5.4 笔画序列推出原汉字: orderToWord

cnchar.orderToWord(orderNames[,...args]);

var dict = cnchar.orderToWord.orders; // dict 是一个包含所有笔画数的详细信息的json数据

{
 卧钩: {shape: "㇃", letter: "y", sameLetterTo: "斜钩"}
 弯钩: {shape: "㇁", letter: "t"}
 捺: {shape: "㇏", letter: "l"}
 提: {shape: "㇀", letter: "i"}
 撇: {shape: "丿", letter: "s"}
 撇折: {shape: "𠃋", letter: "n"}
 撇点: {shape: "𡿨", letter: "m"}
 斜钩: {shape: "㇂", letter: "y", sameLetterTo: "卧钩"}
 横: {shape: "一", letter: "j"}
 横折: {shape: "𠃍", letter: "c"}
 横折弯: {shape: "㇍", letter: "v", sameLetterTo: "横折折"}
 横折折: {shape: "㇅", letter: "v", sameLetterTo: "横折弯"}
 横折折折: {shape: "㇎", letter: "q"}
 横折折折钩: {shape: "𠄎", letter: "w", sameLetterTo: "横撇弯钩"}
 横折折撇: {shape: "㇋", letter: "a"}
 横折提: {shape: "㇊", letter: "p"}
 横折钩: {shape: "𠃌", letter: "r"}
 横撇: {shape: "㇇", letter: "e", sameLetterTo: "横钩"}
 横撇弯钩: {shape: "㇌", letter: "w", sameLetterTo: "横折折折钩"}
 横斜钩: {shape: "⺄", letter: "o"}
 横钩: {shape: "乛", letter: "e", sameLetterTo: "横撇"}
 点: {shape: "丶", letter: "k"}
 点2: {shape: "㇀", letter: "d"}
 竖: {shape: "丨", letter: "f"}
 竖弯: {shape: "㇄", letter: "b"}
 竖弯钩: {shape: "乚", letter: "u"}
 竖折折: {shape: "𠃑", letter: "x", sameLetterTo: "竖折撇"}
 竖折折钩: {shape: "㇉", letter: "z"}
 竖折撇: {shape: "ㄣ", letter: "x", sameLetterTo: "竖折折"}
 竖提: {shape: "𠄌", letter: "h"}
 竖钩: {shape: "亅", letter: "g"}
}

cnchar.orderToWord(['横', '撇', '捺']);
// 等价于 
cnchar.orderToWord('横 撇 捺');
// 返回 "丈大"
cnchar.orderToWord(['横', '撇', '捺'], 'array');
// 返回 ["丈","大"]
cnchar.orderToWord(['横', '撇', '捺'], 'start');
// 返回 "丈大太*夯夸夺夼奁奄奈奋奔态奎耷套奢瓠鹩奪奮遼"
cnchar.orderToWord(['横', '撇', '捺'], 'start', 'simple');
// 返回 "丈大太*夯夸夺夼奁奄奈奋奔态奎耷套奢瓠鹩"

5.5 通过拼音查询原汉字: spellToWord

cnchar.spellToWord(spell[,...args]);

cnchar.spellToWord('shàng'); // 返回 '上尚绱鞝'
cnchar.spellToWord('shàng', 'alltone'); // 返回 '上伤汤尚垧殇晌商绱觞赏墒熵裳傷湯殤鞝觴賞'
cnchar.spellToWord('shang4', 'alltone', 'trad'); // 返回 '傷湯殤鞝觴賞'
cnchar.spellToWord('lv2', 'simple'); // 返回 '驴闾榈'

5.6 通过笔画数查询原汉字: strokeToWord

cnchar.strokeToWord(strokeCount[,...args]);

cnchar.strokeToWord(25); // 返回 '鬣馕囔戆攮纛饞躥顱籮蠻廳灣鑲鑰'
cnchar.strokeToWord(25, 'simple'); // 返回 '鬣馕囔戆攮纛'
cnchar.strokeToWord(1, 'array'); // 返回 ['一', '乙']

5.7 成语功能

cnchar.idiom(text: string | number | Array<string|number>):Array<string>;

// 根据汉字查询成语,末尾的空格可以省略
cnchar.idiom(['五', '', '十', '']); // ['五风十雨', '五光十色']
// 根据笔画数查询成语,0表示匹配任意笔画,末尾的0可以省略
cnchar.idiom([4, 6, 2, 0]); // ["不当人子", ... ]
// 根据拼音查询成语
cnchar.idiom('shang'); // ["伤风败化", "伤风败俗", ...]
// 带音调
cnchar.idiom('shang4'); // ["上兵伐谋", "上不着天,下不着地", ... ]

5.8 歇后语功能

cnchar.xhy(text:string, ...xhyArgs: Array<xhyArg>):Array<string>;

// 精确查询
cnchar.xhy('大水冲了龙王庙'); // ['大水冲了龙王庙-自家人不识自家人', '大水冲了龙王庙-一家人不认一家人'],
// 模糊查询
cnchar.xhy('大水', 'fuzzy'); // ['江河里长大水-泥沙俱下', '江河发大水-后浪推前浪', ... ]
// 只返回答案结果
cnchar.xhy('大水', 'fuzzy', 'answer'); // ['泥沙俱下', '后浪推前浪', ... ]
// 根据歇后语后一句查询
cnchar.xhy('上晃下摇', 'fuzzy', 'answer', 'second'); // ['醉汉过铁索桥', '扶着醉汉过破桥']

5.9 偏旁部首功能

cnchar.radical(text:string | Array<string>): Array<{
 radical: string;
 struct: TStruct;
 radicalCount: number;
}>

5.10 组词功能

cnchar.words(words: string, ...args: string[]): string[];

cnchar.words('你');
cnchar.words.addWords('你们好'); // 添加一个词组

5.11 查询解释功能

cnchar.explain(words: string, ...args: string[]): string[];

cnchar.explain('你好');
cnchar.explain.addExplain('你好', '打招呼'); // 添加解释
cnchar.explain.addExplain({
 '你好': '打招呼'
});

5.12 发音、语音合成和语音识别

5.12.1 voice api

cnchar.voice(words: string, options: IVoiceOptions): IVoicePlayer;

5.12.2 speak api

cnchar.voice.speak(text: string, options?: ISpeakOptions): SpeechSynthesisUtterance;

5.12.2 regonize api

cnchar.voice.regonize(options?: IRecognizeOptions): any;

5.13 汉字、拼音工具方法

5.13.1 查询拼音详细信息: spellInfo

cnchar.spellInfo(spell);

cnchar.spellInfo('Shàng');
/*
// 返回值与含义如下
{
 spell: 'shang', // 无音调拼音 
 initial: 'sh', // 声母
 final: 'ang', // 韵母
 tone: 4, // 音调
 index: 3 // 音调位置
},
*/

cnchar.spellInfo.initials;
// ['b', 'p', 'm', 'f', 'd', 't', 'n', 'l', 'g', 'k', 'h', 'j', 'q', 'x', 'zh', 'ch', 'sh', 'r', 'z', 'c', 's', 'y', 'w']
cnchar.spellInfo.tones;
// ['ā', 'á', 'ǎ', 'à', 'ō', 'ó', 'ǒ', 'ò', 'ē', 'é', 'ě', 'è', 'ī', 'í', 'ǐ', 'ì', 'ū', 'ú', 'ǔ', 'ù', 'ǖ', 'ǘ', 'ǚ', 'ǜ', '*', 'ń', 'ň', 'ǹ']
// n 的一声使用 * 代替

5.13.2 拼音音调操作: transformTone

cnchar.transformTone(spell: string, tone?: boolean, type?: 'low' | 'up');
/* 返回值
{
 spell: string; // 转换后的拼音
 tone: toneType; // 声调
 index: number; // 音调位置
 isTrans: boolean; // 是否是经过转换的比如 lv2 -> lǘ
}
*/

5.13.3 是否是汉字: isCnChar

cnchar.isCnChar(word: string): boolean;

5.13.4 是否是多音字: isPolyWord

cnchar.isPolyWord(word: string): boolean;

5.13.5 比较拼音(汉字)大小: compareSpell

cnchar.compareSpell(spell1: string, spell2: string, tone?: boolean);

cnchar.compareSpell('ao', 'ai') // 返回 'more' 因为 o 排在 i 之后
cnchar.compareSpell('奥', 'ai') // 返回 'more'

5.13.6 比较汉字笔画数大小: compareStroke

cnchar.compareStroke(stroke1: string, stroke2: string);

cnchar.compareStroke('你', '好') // 返回 'more'
cnchar.compareStroke(20, '好') // 返回 'more'
cnchar.compareStroke('一个', '好') // 返回 'less'

5.13.7 根据拼音排序: sortSpell

cnchar.sortSpell(spells:Array<string> | string, ...args?: Array<'tone'|'desc'>): Array<string> | string;

cnchar.sortSpell(['你', '好', '吗']) // ['好', '吗', '你']
cnchar.sortSpell('你好吗') // '好吗你'
cnchar.sortSpell('拼品频爱', 'tone', 'desc') // '品频拼爱'

5.13.8 根据笔画数排序: sortStroke

cnchar.sortStroke(strokes:Array<string|number> | string, desc?: 'desc'): Array<string> | string;

cnchar.sortStroke(['一', '三', '二']) // ['一', '二', '三']
cnchar.sortStroke(['一', '三', 2]) // ['一', 2, '三'],
cnchar.sortStroke('一三二', 'desc') // '三二一'

5.13.9 将数字表示的声调转为拼音声调: shapeSpell

cnchar.shapeSpell(spell: string, reverse?: boolean): string;

5.13.10 判断拼音是否有音调: hasTone

cnchar.hasTone(spell: string): boolean;

5.14 自定义数据

5.14.1 setSpell

cnchar.setSpell(word: string, spell: string): void;
cnchar.setSpell(json: {[key: string]: string}): void;

5.14.2 setSpellDefault

cnchar.setSpellDefault(word: string, spell: string): void;
cnchar.setSpellDefault(json: {[key: string]: string}): void;

5.14.3 setStrokeCount

cnchar.setStrokeCount(word: string, count: number): void;
cnchar.setStrokeCount(json: {[key: string]: number}): void;

5.14.4 setPolyPhrase

cnchar.setPolyPhrase(word: string, spell: string): void;
cnchar.setPolyPhrase(json: {[key: string]: string}): void;

5.14.5 setOrder

cnchar.setOrder(word: string, order: string): void;
cnchar.setOrder(json: {[key: string]: string}): void;

5.14.6 setRadical

cnchar.radical.setRadical(word: string, radical: IRadicalResult): void;
cnchar.radical.setRadical(json: {[key: string]: IRadicalResult}): void;

5.14.7 addXhy

cnchar.xhy.addXhy(args: Array<Array<string> | string>): void;
cnchar.xhy.addXhy(xhyHead: string, xhyTail: string): void;

5.14.8 addWords

cnchar.words.addWords(words: string | string[]): void;

5.14.9 addExplain

cnchar.explain.addExplain(json: Json<string>): void;
cnchar.explain.addExplain(words: string, explain: string): void;

5.14.10 addVoice

cnchar.voice.addVoice(json: Json<string>): void;
cnchar.voice.addVoice(words: string, url: string): void;

5.15 其他 api

5.15.1 .use()

cnchar.use(...libs);

// 请保证最先引入 cnchar 基础库,其他插件库顺序无所谓
var cnchar = require('cnchar');
var xxx = require('cnchar-xxx');
cnchar.use(xxx);

// 请保证最先引入 cnchar 基础库,其他几个库顺序无所谓
import cnchar from 'cnchar';
import 'cnchar-xxx';

5.15.2 .type

var spellArg = cnchar.type.spell;
var strokeArg = cnchar.type.stroke;
var orderToWordArg = cnchar.type.orderToWord;
var spellToWordArg = cnchar.type.spellToWord;
var strokeToWordArg = cnchar.type.strokeToWord;
var xhyArg = cnchar.type.xhy;
var radicalArg = cnchar.type.radical;
var wordsArg = cnchar.type.words;
var explainArg = cnchar.type.explain;

5.15.3 .check

cnchar.check = false; // 关闭参数校验

5.15.4 .version & env

var version = cnchar.version;
var env = cnchar.env;

5.15.5 .plugins

var plugins = cnchar.plugins; // array 类型

cnchar.hasPlugin('draw')

5.16 离线使用

5.17 自定义插件

5.17.1 pluginName属性

5.17.2 install属性

5.17.3 getCnChar

5.17.4 js定义插件

export default {
 pluginName: 'custom',
 install (cnchar) {
 console.log(cnchar);
 },
 version: '0.0.1',
 log: () => console.log('hello cnchar-plugin!');
}

5.17.5 ts定义插件

npm i cnchar-types

import ICnChar, {IPlugin} from 'cnchar-types';
const plugin: IPlugin = {
 pluginName: 'custom',
 install (cnchar: ICnChar) {
 console.log(cnchar);
 },
 version: '0.0.1',
 log: () => console.log('hello cnchar-plugin!');
};
declare module 'cnchar-types/main/index' {
 interface ICnChar {
 custom: {
 pluginName: 'custom';
 version: string;
 log: () => void;
 };
 }
}
export default plugin;

const plugin: {
 pluginName: string;
 install: (cnchar: any) => any;
} = {
 pluginName: 'custom',
 install (cnchar: any) {
 console.log(cnchar);
 },
 version: '0.0.1',
 log: () => console.log('hello cnchar-plugin!');
};
export default plugin;

6.参数介绍

6.1 spell 参数

cnchar.spell(string,arg1,arg2,...);
string.spell(arg1,arg2,...)

6.2 stroke 参数

cnchar.stroke(string,arg1,arg2,...);
string.stroke(arg1,arg2,...);

6.3 orderToWord 参数

cnchar.orderToWord(orders,arg1,arg2,...);

6.4 spellToWord 参数

cnchar.spellToWord(spell,arg1,arg2,...);

6.5 strokeToWord 参数

cnchar.strokeToWord(count,arg1,arg2,...);

6.6 idiom 参数

cnchar.idiom(value);

6.7 xhy 参数

cnchar.xhy(value,arg1,arg2,...);

6.8 radical 参数

cnchar.radical(value);

6.9 words 与 explain 参数

cnchar.words(value,arg1,arg2,...);
cnchar.explain(value,arg1,arg2,...);

6.10 使用实例大全:

6.10.0 安装使用

npm i cnchar

import cnchar from 'cnchar';
// do something

<script src="https://fastly.jsdelivr.net/gh/theajack/cnchar/dist/cnchar.latest.min.js"></script>
<script>
 // do something
</script>

6.10.1 cnchar 基础库功能

//spell 功能
'测试'.spell(); // 返回 'CeShi'
'测试'.spell('up'); // 返回 'CESHI'
'测试'.spell('low'); // 返回 'ceshi'
'测试'.spell('first'); // 返回 'CS'
'测试'.spell('first', 'low'); // 返回 'cs'
'测试'.spell('array'); // 返回 ['Ce','Shi']
'测试'.spell('array', 'first', 'low'); // 返回 ['c','s']
'测试'.spell('tone'); // 返回 'CèShì'
'长大了'.spell('poly'); // 返回 '(Zhang|Chang)(Da|Dai)(Le|Liao)'
//stroke 功能
'测'.stroke(); // 返回 9
'测试'.stroke(); // 返回 17
'测试'.stroke('array'); // 返回 [9,8]
//spellToWord 功能
cnchar.spellToWord('shàng'); // 返回 "上尚绱"
cnchar.spellToWord('lv2'); // 返回 "驴闾榈"
//strokeToWord 功能
cnchar.strokeToWord(2); // 返回 "丁七乃乜九了二人亻儿入八冂几凵刀刁力勹"

6.10.2 cnchar-poly 库功能

'长大了'.spell(); // 返回 'ZhangDaLe'
'长大了'.spell('array'); // 返回 ["Zhang", "Da", "Le"]
'长大了'.spell('poly'); // 返回 '(Zhang|Chang)(Da|Dai)(Le|Liao)'

6.10.3 cnchar-order 库功能

'一个'.stroke('order'); // 返回 ["j","slf"] 需要显式使用 order 参数 默认返回笔画数字母序列
'一个'.stroke('order', 'detail'); //
/* 返回详细笔画信息:
[
 [{
 "shape": "㇐", 
 "type": "平笔", 
 "foldCount": "0", 
 "name": "横"
 }],[{
 "shape": "㇓", 
 "type": "平笔", 
 "foldCount": "0", 
 "name": "撇"
 },{
 "shape": "㇏", 
 "type": "平笔", 
 "foldCount": "0", 
 "name": "捺"
 },{
 "shape": "㇑", 
 "type": "平笔", 
 "foldCount": "0", 
 "name": "竖"
 }]
]*/
'一个'.stroke('order', 'shape'); // 返回 [["㇐"],["㇓","㇏","㇑"]]
'一个'.stroke('order', 'name'); // 返回 [["横"],["撇", "捺", "竖"]]
'一个'.stroke('order', 'count'); // 返回 [1, 3]

var orders = cnchar.orderToWord.orders; //查看支持的笔画名称
cnchar.orderToWord(['横', '撇', '捺']);
// 返回 "丈大"
cnchar.orderToWord(['横', '撇', '捺'], 'array');
// 返回 ["丈","大"]
cnchar.orderToWord(['横', '撇', '捺'], 'start');
// 返回 "丈大太*夯夸夺夼奁奄奈奋奔态奎耷套奢瓠鹩奪奮遼"
cnchar.orderToWord(['横', '撇', '捺'], 'start', 'simple');
// 返回 "丈大太*夯夸夺夼奁奄奈奋奔态奎耷套奢瓠鹩"
cnchar.orderToWord(['横', '撇', '捺'], 'match');
// 返回 "丈大仄兮友天太夫夭尺攵文木犬长丛仗仝叭..." // 省略后面的
cnchar.orderToWord(['横', '撇', '捺'], 'matchorder');
// 返回 "丈大仄友天太夫夭尺攵文木犬仗叭史央夯失..." // 省略后面的
cnchar.orderToWord(['横', '撇', '捺'], 'contain');
// 返回 "丈大天太夫夭尺攵文犬仗叭史央夯失疋矢乔..." // 省略后面的

6.10.4 cnchar-trad 库功能

6.10.4.1 convert 字体转换

'一个人'.convertSimpleToTrad(); // 返回 "壹個人" 等价于 cnchar.convert.simpleToTrad
cnchar.convert.simpleToTrad('一个人');
'一个人'.convertSimpleToSpark(); // 返回 "1个亾" 等价于 cnchar.convert.simpleToSpark
cnchar.convert.simpleToSpark('一个人');
'壹個人'.convertTradToSimple(); // 返回 "一个人" 等价于 cnchar.convert.tradToSimple
cnchar.convert.tradToSimple('壹個人');
'壹個人'.convertTradToSpark(); // 返回 "1个亾" 等价于 cnchar.convert.tradToSpark
cnchar.convert.tradToSpark('壹個人');
'1个亾'.convertSparkToSimple(); // 返回 "一个人" 等价于 cnchar.convert.sparkToSimple
cnchar.convert.sparkToSimple('1个亾');
'1个亾'.convertSparkToTrad(); // 返回 "壹個人" 等价于 cnchar.convert.sparkToTrad
cnchar.convert.sparkToTrad('1个亾');

6.10.4.2 spell 和 stroke 方法

//spell 功能
'長大'.spell(); // 返回 'ZhangDa'
'長大'.spell('simple'); // 返回 '長Da' // 禁用繁体字拼音功能
//stroke 功能
'長大'.stroke('array'); // 返回 [8, 3]
'長大'.stroke('array', 'simple'); // 返回 [0, 3] // 禁用繁体字笔画功能
'長大'.stroke('order', 'shape'); // 返回 [["㇐","㇑","㇐","㇐","㇐","㇙","㇓","㇏"],["㇐","㇓","㇏"]]
'長大'.stroke('order', 'shape', 'simple'); // 返回 [undefined, ["㇐","㇓","㇏"]]

6.10.5 cnchar-idiom 库功能

cnchar.idiom(['五', '', '十', '']) // ['五风十雨', '五光十色']
cnchar.idiom([4, 6, 2, 6]) // ['五光十色']
cnchar.idiom('shang') // ['伤风败化', '伤风败俗', ... ]
cnchar.idiom('shang4') // ['伤风败化', '伤风败俗', ... ]

6.10.6 cnchar-xhy 库功能

cnchar.xhy('大水冲了龙王庙') // ['大水冲了龙王庙-自家人不识自家人', '大水冲了龙王庙-一家人不认一家人']
cnchar.xhy('大水', 'fuzzy') // ['江河里长大水-泥沙俱下', '江河发大水-后浪推前浪', ... ]
cnchar.xhy('大水', 'fuzzy', 'answer') // ['泥沙俱下', '后浪推前浪', ... ]
cnchar.xhy('上晃下摇', 'fuzzy', 'answer', 'second') // ['醉汉过铁索桥', '扶着醉汉过破桥']

6.10.7 cnchar-radical 库功能

cnchar.radical('你'); // [{radicalCount: 2, radical: '亻', struct: '左右结构'}],
cnchar.radical('你好呀'); // ...
cnchar.radical(["你", "好", "呀"]); // ...

6.10.8 cnchar-words

cnchar.words('香蕉');
cnchar.words.addWords('香蕉牛奶');
cnchar.words('香蕉');

6.10.8 cnchar-explain

cnchar.explain('你好');
cnchar.explain.addExplain('你好', '打招呼');
cnchar.explain('你好');

6.10.10 cnchar-voice

cnchar.voice('你好');
window.addEventListener('click', ()=>{
 cnchar.voice.speak('你好');
 cnchar.voice.regonize();
});

6.10.11 工具方法

6.10.11.1 spellInfo

cnchar.spellInfo('shàng');
// 返回 {spell: "shang", tone: 4, index: 3, initial: "sh", final: "ang"}

6.10.11.2 isCnChar

cnchar.isCnChar('a') // false
cnchar.isCnChar('1') // false
cnchar.isCnChar('?') // false
cnchar.isCnChar('国') // true
cnchar.isCnChar('國') // true

6.10.11.3 transformTone

cnchar.transformTone('lv2') // {spell: 'lü', tone: 2, index: 2, isTrans: true}
cnchar.transformTone('lv2', true) // {spell: 'lǘ', tone: 2, index: 2, isTrans: true}
cnchar.transformTone('lv2', true, 'up') // {spell: 'LǗ', tone: 2, index: 2, isTrans: true}
cnchar.transformTone('lǘ') // {spell: 'lü', tone: 2, index: 2, isTrans: false}

6.10.11.4 compareSpell

cnchar.compareSpell('ao', 'ai') // 'more'
cnchar.compareSpell('ai', 'ai') // 'even'
cnchar.compareSpell('pín', 'pǐn', true) // 'less'
cnchar.compareSpell('pin2', 'pǐn', true) // 'less'
cnchar.compareSpell('频', 'pǐn', true) // 'less'
cnchar.compareSpell('品', '频', true) // 'more'
cnchar.compareSpell('贫', '频', true) // 'even'

6.10.11.5 compareStroke

cnchar.compareStroke('你', '好') // 'more'
cnchar.compareStroke('你', '苏') // 'even'
cnchar.compareStroke('好', '苏') // 'less'
cnchar.compareStroke('一个', '好') // 'less'
cnchar.compareStroke('你', 14) // 'less'

6.10.11.6 sortSpell

cnchar.sortSpell(['你', '好', '吗']) // ['好', '吗', '你']
cnchar.sortSpell('你好吗') // '好吗你'
cnchar.sortSpell(['拼', '品', '频', '爱'], 'tone') // ['爱', '拼', '频', '品']
cnchar.sortSpell(['拼', '品', 'pin2', 'ai'], 'tone') // ['ai', '拼', 'pin2', '品']
cnchar.sortSpell(['拼', '品', '频', '爱'], 'tone', 'desc') // ['品', '频', '拼', '爱']
cnchar.sortSpell('拼品频爱', 'tone', 'desc') // '品频拼爱'

6.10.11.7 sortStroke

cnchar.sortStroke(['一', '三', '二']) // ['一', '二', '三']
cnchar.sortStroke('一三二') // '一二三'
cnchar.sortStroke(['一', '三', 2]) // ['一', 2, '三']
cnchar.sortStroke(['一', '三', '二'], 'desc') // ['三', '二', '一']

6.10.11.8 isPolyWord

cnchar.isPolyWord('中') // true
cnchar.isPolyWord('国') // false

6.10.11.9 shapeSpell

cnchar.shapeSpell('lv2') // lǘ
cnchar.shapeSpell('shang4') // shàng
cnchar.shapeSpell('lǘ', true) // lv2

6.10.11.10 setSpell

// 用于添加cnchar中不包含的汉字 或修改 cnchar中有误的汉字
cnchar.setSpell('x', 'x');
cnchar.setSpell('x', ['x1', 'x2']); // 多个读音
cnchar.setSpell({ // 多个汉字
 'x': 'x',
 'y': ['y1', 'y2']
});

6.10.11.11 setSpellDefault

// 用于设置或修改 cnchar 中多音字的默认读音
cnchar.setSpellDefault('长', 'zhǎng');
cnchar.setSpellDefault({ // 多个汉字
 '长': 'zhǎng',
 '中': 'zhòng'
});

6.10.11.12 setStrokeCount

// 用于添加cnchar中不包含的汉字 或修改 cnchar中有误的汉字
cnchar.setStrokeCount('大', 3);
cnchar.setStrokeCount({ // 多个
 '大': 3,
 '子': 3
});

6.10.11.13 setOrder

// 用于添加cnchar中不包含的汉字 或修改 cnchar中有误的汉字
cnchar.setOrder('大', 'jsl');
cnchar.setOrder({ // 多个
 '大': 'jsl',
 '子': 'egj'
});

6.10.11.14 setPolyPhrase

// 用于添加cnchar中不包含的词组 或修改 cnchar中有误的词组
cnchar.setPolyPhrase('测试', 'cè shi4');
cnchar.setPolyPhrase({ // 多个
 '测试': 'cè shì',
 '体验': 'tǐ yàn'
});

6.10.11.15 setRadical

// 用于添加cnchar中不包含的汉字 或修改 cnchar中有误的汉字
cnchar.radical.setRadical('x', {radical:'', struct: '', radicalCount: 0});
cnchar.radical.setRadical({ // Multiple Chinese characters
 'x': {radical:'', struct: '', radicalCount: 0},
 'y': {radical:'', struct: '', radicalCount: 0}
});

6.10.11.16 addXhy

cnchar.xhy.addXhy('歇后语第一句', '歇后语第二句');
cnchar.xhy.addXhy([ // 多条
 ['歇后语第一句', '歇后语第二句'],
 ['歇后语第一句2', '歇后语第二句2'],
]);