3.26.0 • Published 9 months ago

pinyin-pro v3.26.0

Weekly downloads
-
License
MIT
Repository
github
Last release
9 months ago

NPM version GITHUB star build-passing NPM Downloads Coverage Status DeepScan grade MIT-license npm bundle size GITHUB-language

📖 介绍

pinyin-pro 是一个专业的 js 汉字拼音转换库,功能丰富、准确率高、性能优异。

中文文档 | English Docs | 在线运行

🎨 特色功能

  • 支持拼音/声母/韵母/首字母/音调/全部信息
  • 支持人名姓氏模式
  • 支持文本和拼音匹配
  • 支持自定义拼音
  • 支持获取带拼音汉字的 HTML 字符串
  • 支持获取汉字的所有拼音
  • 支持拼音输入转换
  • 极致的性能和极高的拼音识别准确率

🔨 安装

npm 安装

npm install pinyin-pro

浏览器引入

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

💡 使用示例

全部功能的使用说明文档请查看在线文档

  • 获取拼音,更多功能请查看pinyin API

    import { pinyin } from "pinyin-pro";
    
    // 获取字符串格式拼音
    pinyin("汉语拼音"); // 'hàn yǔ pīn yīn'
    
    // 获取数组格式拼音
    pinyin("汉语拼音", { type: "array" }); // ["hàn", "yǔ", "pīn", "yīn"]
    
    // 获取不带音调格式拼音
    pinyin("汉语拼音", { toneType: "none" }); // "han yu pin yin"
    
    // 获取不带音调数组格式拼音
    pinyin("汉语拼音", { toneType: "none", type: "array" }); // ["han", "yu", "pin", "yin"]
    
    // 音调以数字形式显示
    pinyin("汉语拼音", { toneType: "num" }); // "han4 yu3 pin1 yin1"
    
    // 自动识别多音字
    pinyin("睡着了"); // "shuì zháo le"
  • 文本和拼音匹配,更多匹配规则请查看match API

    import { match } from "pinyin-pro";
    
    // 支持首字母匹配
    match("中文拼音", "zwp"); // [0, 1, 2]
    
    // 支持全拼匹配
    match("中文拼音", "zhongwenpin"); // [0, 1, 2]
    
    // 支持混合匹配
    match("中文拼音", "zhongwp"); // [0, 1, 2]
  • 拼音格式转换,更多功能请查看convert API

    import { convert } from "pinyin-pro";
    
    // 数组转符号
    convert("pin1 yin1"); // 'pīn yīn'
    
    // 符号转数字
    convert("pīn yīn", { format: "symbolToNum" }); // 'pin1 yin1'
    
    // 消除符号
    convert("pīn yīn", { format: "toneNone" }); // 'pin yin'
  • 获取带汉字拼音的 HTML 字符串,更多配置请查看html API

    import { html } from "pinyin-pro";
    
    // 带拼音汉字的 HTML 字符串
    html("汉语拼音");
    /*
    <span class="py-result-item">
    <ruby>
        <span class="py-chinese-item">汉</span>
        <rp>(</rp>
        <rt class="py-pinyin-item">hàn</rt>
        <rp>)</rp>
    </ruby>
    </span>
    <span class="py-result-item">
    <ruby>
        <span class="py-chinese-item">语</span>
        <rp>(</rp>
        <rt class="py-pinyin-item">yǔ</rt>
        <rp>)</rp>
    </ruby>
    </span>
    */

    上述结果浏览器中预览效果如下: ( hàn ) ( )

🏆 竞品对比

以下是 pinyin-propinyin@napi-rs/pinyin 包对于汉字转换的速度及准确率对比,可以看到 pinyin-pro 在各方面都全面领先。

📠 反馈

使用遇到问题或者需要功能支持欢迎提 issue。

技术交流欢迎加 pinyin-pro 用户群 或者微信:

@jishuxin/dns@infinitebrahmanuniverse/nolb-piny@everything-registry/sub-chunk-2439jdlinker-systemjdlinker-web@rubyli/uitlstalentorg-profile-editortd-octopusswagger-fixwen-vue-uiwen-commonwyc-icon3starry_icon_toolswagger2-toolsvscode-i18n-linterv-ol-mapvue-bag-admin@ctsy/template@dignite-ng/expand.cms@das-fed/utils@runafe/magic-systemapi-seegc-starter-form-createjz-ep-uijogs-log-admin1jmash-regionke-fe-clilantrack-web-adminkyasrassistant@zhangmo8/vite-plugins@zhao2guai/vue3-maptalks@jdlinker/systemnk-i18n-clisummer-admin-protranslate-compilervue-openlayers-slmap@antmjs/api@api-helper/cli@adpro/text-elementalizer-core@aimua/vite-plugins@aligov/clark-core@cheny33/ssml-editor360shitu@codingfly/remax-design@deary/svg2css@deary/utilsyui-test-v2zft-lowcode-control-materialszft-lowcode-control-materials-publiczft-lowcode-control-materials-public-1zft-lowcode-control-materials-threezft-lowcode-control-materials-twoztxkuizyjslibsztgyluivue3-frontend-uizmdms-utilszo-biz-libxt-i18n@feifei633/web-editor@fc-components/menu@easyv/dtable-blocks@easyv/dtable-blocks2@h1mple/auto-i18n-core@h_y_12/vue3-frontend-ui@iep-kit/icons-svg@gdyfe/ssml@fu1996/kiwi-clis@geyj/components@kqinfo/ui@langlangedu/cli@lingxiteam/ebe@lingxiteam/editor@lucifinil/tts-editor@lucilor/utils@linch90/od-highlight-pipe@mgsz/components@mybricks/nocobase-service-interface@meling-hongmei/home-ui@mekumiao/ssml-editor@jayfong/x-utils@jawilx/gen-api@ilxqx/vef-framework@imean/cli@jecloud/utils@jx3box/jx3-skill-parser@kakang/utils@rabkit/x-gantt-elastic@openapi-to/core@pf-ui/pf-ui-vue@opentiny/tiny-engine-plugin-block@pakwoon/client-api@ourschool/design@ourschool/design-mobile@panzhiyue/utilscommonmw-god-modopenapi-requestopenapi-v3-request-generatorpackage-debugsensetime-tsc-components
3.26.0

9 months ago

3.25.0

10 months ago

3.24.0

12 months ago

3.24.2

12 months ago

3.24.1

12 months ago

3.21.1

1 year ago

3.21.0

1 year ago

3.22.0

1 year ago

3.22.2

1 year ago

3.22.1

1 year ago

3.23.1

1 year ago

3.23.0

1 year ago

3.20.4

1 year ago

3.20.3

1 year ago

3.20.2

1 year ago

3.20.1

1 year ago

3.20.0

1 year ago

3.20.0-beta.6

1 year ago

3.19.7

1 year ago

3.20.0-beta.4

1 year ago

3.20.0-beta.5

1 year ago

3.20.0-beta.3

1 year ago

3.20.0-beta.1

1 year ago

3.20.0-beta.2

1 year ago

3.19.6

1 year ago

3.19.5

1 year ago

3.19.4

1 year ago

3.19.3

1 year ago

3.19.2

2 years ago

3.19.1

2 years ago

3.19.0

2 years ago

3.18.6

2 years ago

3.18.5

2 years ago

3.18.4

2 years ago

3.17.0

2 years ago

3.18.1

2 years ago

3.18.0

2 years ago

3.18.3

2 years ago

3.18.2

2 years ago

3.16.7

2 years ago

3.16.6

2 years ago

3.16.5

2 years ago

3.16.4

2 years ago

3.15.1-beta.1

2 years ago

3.14.1-beta.1

2 years ago

3.15.0

2 years ago

3.15.2

2 years ago

3.15.1

2 years ago

3.15.4

2 years ago

3.15.3

2 years ago

3.16.1

2 years ago

3.16.0

2 years ago

3.16.3

2 years ago

3.16.2

2 years ago

3.14.0

2 years ago

3.13.2

2 years ago

3.13.1

2 years ago

3.12.0

3 years ago

3.12.0-alpha.1

3 years ago

3.13.0

3 years ago

3.10.1

3 years ago

3.10.2

3 years ago

3.11.0

3 years ago

3.9.0

3 years ago

3.10.0

3 years ago

3.8.3

3 years ago

3.8.2

3 years ago

3.8.1-alpha.1

3 years ago

3.8.1

3 years ago

3.6.0-alpha

4 years ago

3.7.2

3 years ago

3.4.0

4 years ago

3.6.0-beta

4 years ago

3.8.0

3 years ago

3.6.2

4 years ago

3.6.1

4 years ago

3.6.0

4 years ago

3.4.1

4 years ago

3.7.0-alpha

4 years ago

3.7.1

4 years ago

3.7.0

4 years ago

3.5.0

4 years ago

3.3.1

4 years ago

3.2.4-alpha.0

4 years ago

3.3.0

4 years ago

3.2.3-alpha.0

4 years ago

3.2.3

4 years ago

3.2.2

4 years ago

3.2.1

4 years ago

3.2.0

4 years ago

3.2.0-alpha.0

4 years ago

3.2.0-alpha.1

4 years ago

3.2.0-alpha.2

4 years ago

3.1.0

4 years ago

3.1.0-alpha.1

4 years ago

3.1.0-alpha.2

4 years ago

3.1.0-alpha.0

4 years ago

3.0.7

4 years ago

3.0.2-alpha.0

4 years ago

3.0.4

4 years ago

3.0.3

4 years ago

3.0.2

4 years ago

3.0.6

4 years ago

3.0.5

4 years ago

3.0.6-beta.0

4 years ago

3.0.6-beta.1

4 years ago

3.0.3-alpha.0

4 years ago

3.0.6-alpha.1

4 years ago

3.0.0-alpha.6

4 years ago

3.0.0-alpha.1

4 years ago

3.0.0-alpha.0

4 years ago

3.0.0-alpha.3

4 years ago

3.0.0-alpha.2

4 years ago

3.0.0-alpha.5

4 years ago

2.0.9

4 years ago

3.0.0-alpha.4

4 years ago

3.0.1-alpha.1

4 years ago

3.0.1-alpha.0

4 years ago

3.0.1

4 years ago

2.0.9-alpha.0

4 years ago

2.0.9-alpha.1

4 years ago

3.0.0

4 years ago

2.0.8

4 years ago

2.0.3

4 years ago

2.0.2

4 years ago

2.0.5

4 years ago

2.0.4

4 years ago

2.0.7

4 years ago

2.0.6

4 years ago

2.0.1

4 years ago

2.0.0

4 years ago

1.2.4

5 years ago

1.2.3

5 years ago

1.2.2

5 years ago

1.2.0

5 years ago

1.2.1

5 years ago

1.1.0

5 years ago

1.0.9

5 years ago

1.0.8

5 years ago

1.0.7

5 years ago

1.0.6

5 years ago

1.0.5

5 years ago

1.0.4

5 years ago

1.0.3

5 years ago

1.0.2

5 years ago

1.0.1

5 years ago

1.0.0

5 years ago