ChinesePinyin Code 使用指南

什么是 ChinesePinyin Code？

ChinesePinyin Code 是一个轻量级的 JavaScript 工具库，用于将中文汉字（简体/繁体）转换为对应的拼音。 它无需任何外部依赖，支持浏览器和 Node.js 环境，非常适合在前端项目中集成拼音搜索、输入提示、语音识别等场景。

快速开始

你可以通过 CDN 直接引入，也可以使用 npm 安装。

方式一：CDN 引入（推荐用于网页）

<script src="https://cdn.jsdelivr.net/npm/chinesepinyin-code@latest/dist/index.min.js"></script>

方式二：npm 安装（用于构建项目）

npm install chinesepinyin-code

import { getPinyin } from 'chinesepinyin-code';

基本用法示例

调用 getPinyin(text) 即可获取拼音字符串：

const result = getPinyin('你好世界');
console.log(result); // 输出: "ni hao shi jie"

支持选项配置（如是否带声调、是否分隔多音字等）：

const result = getPinyin('重庆', { tone: true, multiple: true });
// 可能输出: "chóng qìng / chóng qìng"

在线演示

常见应用场景

• 中文通讯录按拼音首字母排序
• 电商商品搜索支持拼音关键词
• 教育类 App 显示生词拼音
• 语音输入辅助校正

注意事项

- 该库基于 Unicode 汉字编码映射表，覆盖常用汉字约 7000+。
- 多音字默认返回最常用读音，可通过配置开启多音模式。
- 非中文字符（如英文、数字、标点）将原样保留。