pinyin-pro Documentation

The @pinyin-pro/data package provides several dictionary datasets to extend the capabilities of pinyin-pro:

• modern.json: Pinyin collection from the Modern Chinese Dictionary (7th Edition) (approx. 0.6 MB gzipped).
• complete.json: Pinyin collection from the jieba Chinese segmentation library (approx. 3.99 MB gzipped).
• chars.json: Supplementary dictionary for rare/uncommon characters (approx. 0.1 KB gzipped).

pinyin-pro is a professional Chinese pinyin conversion library designed for high accuracy and performance. Key capabilities include:

• Chinese Pinyin conversion: Converting Chinese characters to pinyin.
• Segmentation: Segmenting Chinese text.
• Pinyin matching: Matching Chinese text with pinyin.
• HTML string support: Handling pinyin within HTML strings.

The library utilizes algorithms like AC automata, greedy algorithms, and hash function optimization to ensure excellent performance, backed by a massive processed Chinese pinyin database for high recognition accuracy.

You can install pinyin-pro using NPM, Yarn, or pnpm. It is compatible with both Browser and Node.js environments.

# NPM
$ npm install pinyin-pro --save

# Yarn
$ yarn add pinyin-pro

# pnpm
$ pnpm install pinyin-pro

Install the official dictionary extension package for pinyin-pro using your preferred package manager.

npm install @pinyin-pro/data
yarn add @pinyin-pro/data
pnpm add @pinyin-pro/data

Depending on your runtime or build system, use one of the following methods to import the library.

ESM (Modern JavaScript/TypeScript):

import { pinyin } from 'pinyin-pro';

CommonJS (Node.js):

const { pinyin } = require('pinyin-pro');

Browser (Script Tag): Include the script from a CDN. The library will be available under the global pinyinPro object.

<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>

You can use pinyin-pro in the browser by importing CDN files through a <script /> tag. It is recommended to lock the version in the URL to avoid breaking changes from future updates.

When using a script tag, the library mounts a global variable named pinyinPro.

If you encounter usage problems or wish to provide feedback regarding pinyin-pro, you can reach out via the following channels:

• QQ Group: 1042725850
• WeChat: zhoulx1688888

To use addTraditionalDict for improved recognition of traditional Chinese characters, you must install the @pinyin-pro/data package to access the mapping tables.

npm install @pinyin-pro/data