pinyin-pro

简体中文

English

简体中文

English

Appearance

快速开始 ​

环境 ​

pinyin-pro 支持在浏览器和 Nodejs 环境运行。

安装 ​

pinyin-pro 支持使用包管理器安装或者通过 <script />链接引入。

使用包管理器 ​

推荐使用包管理器进行安装：

perl
# 选择一个你喜欢的包管理器

# NPM
$ npm install pinyin-pro --save

# Yarn
$ yarn add pinyin-pro

# pnpm
$ pnpm install pinyin-pro
# 选择一个你喜欢的包管理器

# NPM
$ npm install pinyin-pro --save

# Yarn
$ yarn add pinyin-pro

# pnpm
$ pnpm install pinyin-pro

Script 链接 ​

也可以通过浏览器的 script 标签导入 CDN 文件使用，下面以 unpkg 和 jsDelivr CDN 厂商为例：

unpkg ​

html
<!-- 引入固定版本 -->
<head>
  <script src="https://unpkg.com/pinyin-pro@3.18.2/dist/index.js"></script>
</head>

<!-- 自动引入最新版本 -->
<head>
  <script src="https://unpkg.com/pinyin-pro"></script>
</head>
<!-- 引入固定版本 -->
<head>
  <script src="https://unpkg.com/pinyin-pro@3.18.2/dist/index.js"></script>
</head>

<!-- 自动引入最新版本 -->
<head>
  <script src="https://unpkg.com/pinyin-pro"></script>
</head>

jsDelivr ​

html
<!-- 引入固定版本 -->
<head>
  <script src="https://cdn.jsdelivr.net/npm/pinyin-pro@3.18.2/dist/index.js"></script>
</head>

<!-- 自动引入最新版本 -->
<head>
  <script src="https://cdn.jsdelivr.net/npm/pinyin-pro"></script>
</head>
<!-- 引入固定版本 -->
<head>
  <script src="https://cdn.jsdelivr.net/npm/pinyin-pro@3.18.2/dist/index.js"></script>
</head>

<!-- 自动引入最新版本 -->
<head>
  <script src="https://cdn.jsdelivr.net/npm/pinyin-pro"></script>
</head>

TIP

我们建议使用 CDN 引入 pinyin-pro 的用户在链接地址上锁定版本，以固定版本的方式引入，以免将来 pinyin-pro 升级时受到非兼容性更新的影响。如果你有自己的 CDN，也建议将 pinyin-pro 文件下载下来托管到你自己的 CDN 上，以免第三方 CDN 不稳定带来的影响。

使用 ​

支持多种环境及模块化规范的使用方式。

ESM ​

js
import { pinyin } from 'pinyin-pro';

pinyin('汉语拼音'); // 'hàn yǔ pīn yīn'
import { pinyin } from 'pinyin-pro';

pinyin('汉语拼音'); // 'hàn yǔ pīn yīn'

动态导入 ​

js
import('pinyin-pro').then((exports) => {
  exports.pinyin('汉语拼音'); // 'hàn yǔ pīn yīn'
});
import('pinyin-pro').then((exports) => {
  exports.pinyin('汉语拼音'); // 'hàn yǔ pīn yīn'
});

Script 连接 ​

当你使用 <script /> 引入 pinyin-pro 时，会在全局(window)挂载一个名为 pinyinPro 变量。

html
<script src="https://unpkg.com/pinyin-pro"></script>

<script>
  var { pinyin } = pinyinPro;
  pinyin('汉语拼音'); // 'hàn yǔ pīn yīn'
</script>
<script src="https://unpkg.com/pinyin-pro"></script>

<script>
  var { pinyin } = pinyinPro;
  pinyin('汉语拼音'); // 'hàn yǔ pīn yīn'
</script>

CommonJS ​

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

pinyin('汉语拼音'); // 'hàn yǔ pīn yīn'
const { pinyin } = require('pinyin-pro');

pinyin('汉语拼音'); // 'hàn yǔ pīn yīn'