pinyin-pro

中文转拼音、拼音音调、拼音声母、拼音韵母、多音字拼音、姓氏拼音、拼音匹配、中文分词

MIT License

Downloads
141.7K
Stars
3.8K
Committers
19

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(""); // 'hn y pn yn'
    
    // 
    pinyin("", { type: "array" }); // ["hn", "y", "pn", "yn"]
    
    // 
    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 zho 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"); // 'pn yn'
    
    // 
    convert("pn yn", { format: "symbolToNum" }); // 'pin1 yin1'
    
    // 
    convert("pn yn", { 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">hn</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>
*/

pinyin-pro``pinyin @napi-rs/pinyin pinyin-pro

issue

pinyin-pro