wechat-emoji-parser
v2.3.1
Published
微信表情
Downloads
418
Maintainers
Readme
wechat-emoji-parser
微信表情解析工具,可以实现表情解析和表情发送功能
- 可用于公众号接收用户表情消息,将表情码转换为对应的表情 html 内容
- 还可以获取聊天表情,可以应用于聊天应用的表情
install(安装)
npm:
npm install wechat-emoji-parser
pnpm:
pnpm add wechat-emoji-parser
How to use(使用)
getEmojis(option):获取表情
import { getEmojis } from 'wechat-emoji-parser'
let emojis = getEmojis({ size: 24 })
/*emojis
[
{
cn: "[右哼哼]"
code: "/:@>"
style:{
background: "url(...) no-repeat"
background-size: "24px"
display: "inline-block"
height: "24px"
width: "24px"
}
....
]
*/
输入:option: {size: number}
| 属性名 | 类型 | 默认值 | 说明 | | -------------- | ------ | --------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | | size | number | 64 | emoji 大小,单位 px |
输出 emojis:
[
{
code: string,
cn: string,
style: {
display: string,
background: string,
width: string,
height: string,
'background-size': string,
}
}]
| 属性名 | 类型 | 默认值 | 说明 | | ------ | ------ | ------ | -------------------------- | | code | string | | emoji 对应的编码,如:/:@> | | cn | string | | 中文显示,如:[右哼哼] | | style | Object | | |
parseEmoji(str) 解析表情
import { parseEmoji, configParseEmoji } from 'wechat-emoji-parser'
configParseEmoji({ size: 30 }) // 设置一些参数
const res = parseEmoji('哈哈[西瓜]') // 解析文本
configParseEmoji(option: object) 配置解析规则
| 属性名 | 类型 | 默认值 | 说明 | | -------------- | ------ | --------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | | size | number | 64 | emoji 大小,单位 px | | tag | string | 'a' | 解析后的 html 标签 |
parseEmoji(str: string)
输入:待解析的文本
输出:解析后的内容
Example
Contribution(贡献)
- 添加表情 在src/assets/emojis里面加上表情图片
- 添加表情配置 然后在emoji.json里面加上表情的编码规则,src字段对应表情图片的位置