一般实现汉字转拼音的功能都是请求服务端 api 实现,而对于一些比较简单的需求,我们可以通过一个 npm 工具包 —— pinyin-pro ,纯前端实现中文汉字转拼音的功能。
特色功能
- 支持汉字、词语、句子多种格式输入获取
- 获取拼音
- 获取声母
- 获取韵母
- 获取拼音首字母
- 获取音调
- 获取多音字的多种拼音
- 支持人名姓氏模式
- 支持自定义拼音
- 支持字符串和数组两种输出形式
版本更新
当前版本: 3.3.1 -> 3.4.0
- 新增功能
- 问题修复
修复文本过长时堆栈溢出问题 - 字音校准
- 褚: ‘zhǔ’ -> ‘chǔ zhǔ’
- 俞: ‘yù’ -> ‘yú yù’
- 臧: ‘zàng’ -> ‘zāng’
- 贲: ‘bì’ -> ‘bēn bì’
- 莘: ‘xīn’ -> ‘shēn xīn’
- 郦: ‘zhí’ -> ‘lì zhí’
点击查看 版本更新文档
安装
npm 安装
npm install pinyin-pro
yarn 安装
yarn add pinyin-pro
引入
浏览器 script 引入:
<!--引入某个版本,如3.3.0版本-->
<!-- <script src="https://cdn.jsdelivr.net/gh/zh-lx/pinyin-pro@3.3.0/dist/pinyin-pro.js"></script> -->
<!--引入最新版本-->
<script src="https://cdn.jsdelivr.net/gh/zh-lx/pinyin-pro@latest/dist/pinyin-pro.js"></script>
<script>
var {
pinyin } = pinyinPro;
pinyin('汉语拼音'); // 'hàn yǔ pīn yīn'
</script>
ESModule 引入:
import {
pinyin } from 'pinyin-pro';
pinyin('汉语拼音'); // 'hàn yǔ pīn yīn'
commonjs 引入:
const {
pinyin } = require('pinyin-pro');
pinyin('汉语拼音'); // 'hàn yǔ pīn yīn'
参数
pinyin(word, options)
接收两个参数
- word:必填。String 类型,需要转化为拼音的中文
- options:可选。Object 类型,用于配置各种输出形式,options 的键值配置如下:
参数 | 说明 | 类型 | 可选值 | 默认值 |
---|---|---|---|---|
pattern | 输出的结果的信息(拼音 / 声母 / 韵母 / 音调 / 首字母) | string | pinyin / initial / final / nu |