| Key |
Type |
Description |
Optional Values |
Default Value |
| resultClass |
string |
class of the outermost <span> tag of Chinese characters and pinyin |
- |
py-result-item |
| pinyinClass |
string |
class of the outer <rt> tag of Pinyin |
- |
py-pinyin-item |
| chineseClass |
string |
class of the outer <span> tag of Chinese character |
- |
py-chinese-item |
| wrapNonChinese |
string |
Whether use <span> to wrap non Chinese characters. If you want to do some custom style processing for non Chinese characters, it is recommended to set it to true; If the input text parameter is also an HTML string, it is recommended to set it to false to prevent affecting the structure of the text. |
true/false |
false |
| nonChineseClass |
string |
class of the outer <span> tag of non Chinese character(Only when the value of wrapNonChinese is true, it is work.) |
- |
py-non-chinese-item |
| toneType |
string |
the display form of tones in Pinyin |
symbol/none/num |
symbol |
---
### Packages Docs En Docs Use Match (`packages/docs/en/docs/use/match.md`)
# match
| Attribute |
Type |
Description |
Optional Values |
Detail |
Default Value |
| precision |
string |
matching accuracy |
first |
matching is considered successful when the initial letter or full pinyin is equal to the current pinyin |
first |
| start |
starting with the current pinyin is considered a successful match |
| every |
full Pinyin and current Pinyin are strictly equal in order to be considered a successful match |
| any |
containing all characters of the current pinyin are considered as successful matches |
| continuous |
boolean |
Whether the matching Chinese indexes need to be continuous in order to be considered successful |
true |
not required |
false |
| false |
required |
| space |
string |
handling of spaces in Chinese characters and pinyin during matching |
ignore |
ignore |
ignore |
| preserve |
preserve |
| lastPrecision |
string |
the accuracy of the last character matching |
first |
Matching is considered successful when the initial letter or full pinyin is equal to the current pinyin |
By default, when the precision is any, lastPrecision is any; Otherwise lastPrecision is start |
| start |
starting with the current pinyin is considered a successful match |
| every |
full Pinyin and current Pinyin are strictly equal in order to be considered a successful match |
| any |
containing all characters of the current pinyin are considered as successful matches |
| v |
boolean |
Whether to allow using v to match ü |
true |
allow using v to match ü |
false |
| false |
not allow using v to match ü |
---
### Packages Docs En Docs Use Others (`packages/docs/en/docs/use/others.md`)
# pinyin
The `pinyin-pro` package also exports some intermediate processing functions for users to utilize.
### getInitialAndFinal
You can use `getInitialAndFinal` to obtain the initial (consonant) and final (vowel) parts of a specified pinyin:
```js
import { getInitialAndFinal } from 'pinyin-pro';
const result = getInitialAndFinal('guang');
/* The result is:
{
final: 'uang',
initial: 'g',
}
*/
```
### getFinalParts
You can use `getFinalParts` to obtain the medial, nucleus, and coda of a specified pinyin:
```js
import { getFinalParts } from 'pinyin-pro';
const result = getFinalParts('guang');
/* The result is:
{
head: "u",
body: "a",
tail: "ng",
}
*/
```
### getNumOfTone
You can use `getNumOfTone` to obtain the numerical representation of the tones for a specified pinyin:
```js
import { getNumOfTone } from 'pinyin-pro';
const result = getNumOfTone('hàn yǔ de pīn yīn');
/* The result is:
"4 3 0 1 1"
*/
```
---
### Packages Docs En Docs Use Pinyin (`packages/docs/en/docs/use/pinyin.md`)
# pinyin
Using `pinyin` api to convert Chinese into Pinyin and related content.
## Example
### Pinyin
The `options.type` parameter controls the format of the returned value, and the `options.toneType` parameter controls the display format of tones in Pinyin.
```js
import { pinyin } from 'pinyin-pro';
// Get Pinyin with Tones
pinyin('汉语拼音'); // 'hàn yǔ pīn yīn'
// Get Pinyin without Tones
pinyin('汉语拼音', { toneType: 'none' }); // 'han yu pin yin'
// Get Pinyin where the tone is converted to a numerical suffix
pinyin('汉语拼音', { toneType: 'num' }); // 'han4 yu3 pin1 yin1'
// Get Pinyin with Tones in array form
pinyin('汉语拼音', { type: 'array' }); // ["hàn", "yǔ", "pīn", "yīn"]
// Get Pinyin without Tones in array form
pinyin('汉语拼音', { toneType: 'none', type: 'array' }); // ["han", "yu", "pin", "yin"]
// Get Pinyin where the tone is converted to a numerical suffix in array form
pinyin('汉语拼音', { toneType: 'num', type: 'array' }); // ["han4", "yu3", "pin1", "yin1"]
```
### Initial consonants
When `options.pattern` is `initial`, the returned value is initials of Pinyin.
```js
import { pinyin } from 'pinyin-pro';
// Get initial consonants of Pinyin
pinyin('汉语拼音', { pattern: 'initial' }); // 'h y p y'
// Get initial consonants of Pinyin in array form
pinyin('汉语拼音', { pattern: 'initial', type: 'array' }); // ["h", "y", "p", "y"]
```
### Finals
When `options.pattern` is `final`, the returned value is finals of Pinyin.
```js
import { pinyin } from 'pinyin-pro';
// Get vowels of Pinyin with Tones
pinyin('汉语拼音', { pattern: 'final' }); // 'àn ǔ īn īn'
// Get vowels of Pinyin without Tones
pinyin('汉语拼音', { pattern: 'final', toneType: 'none' }); // 'an u in in'
// Get vowels of Pinyin where the tone is converted to a numerical suffix
pinyin('汉语拼音', { pattern: 'final', toneType: 'num' }); // 'an4 u3 in1 in1'
// Get vowels of Pinyin with Tones in array form
pinyin('汉语拼音', { pattern: 'final', type: 'array' }); // ["àn", "ǔ", "īn", "īn"]
// Get vowels of Pinyin without Tones in array form
pinyin('汉语拼音', { pattern: 'final', toneType: 'none', type: 'array' }); // ["an", "u", "in", "in"]
// Get vowels of Pinyin where the tone is converted to a numerical suffix in array form
pinyin('汉语拼音', { pattern: 'final', toneType: 'num', type: 'array' }); // ['an4', 'u3', 'in1', 'in1']
```
### Head/Essential/Tail Vowel 
