https://github.com/cfour-hi/wechat-emoji
微信 emoji 表情插件，包含表情面板、文字转表情功能。
https://github.com/cfour-hi/wechat-emoji
Last synced: 3 months ago
JSON representation
微信 emoji 表情插件，包含表情面板、文字转表情功能。
- Host: GitHub
- URL: https://github.com/cfour-hi/wechat-emoji
- Owner: cfour-hi
- Created: 2020-10-03T03:18:40.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2020-10-06T15:46:29.000Z (over 4 years ago)
- Last Synced: 2025-02-09T11:44:27.198Z (4 months ago)
- Language: JavaScript
- Size: 121 KB
- Stars: 3
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# @znlbwo/wechat-emoji
[](https://coveralls.io/github/znlbwo/wechat-emoji)
> 微信 emoji 表情插件，包含表情面板、文字转表情功能。
## 项目说明
### 用户故事
背景：我司自有一套类 [云雀客服](https://www.yunque360.com/) 的微信公众号管理系统，与公众号粉丝进行聊天互动。
1. 我是一名微信公众号客服，我希望可以给粉丝发送带表情的消息，而不是干巴巴的文字，这样能够让粉丝觉得更亲切、更有温度。
2. 我是一名微信公众号客服，粉丝发送过来的消息，表情无法正常显示。我希望能够显示出表情，这样能够让我更容易理解用户的语气。
### 需求分析
微信内的表情大多是微信团队自己设计的，非标准 [Unicode emoji](https://unicode.org/emoji/charts/full-emoji-list.html)。
在网络传输中，微信非标准 Unicode emoji 使用别名代替，比如 “[微笑]” 或 “/::)”，目前已知是这两种格式的别名。标准 Unicode emoji 因为本身就是 Unicode 字符，所以可以直接在网页中显示。
### 需求确认
1. 表情面板
2. 表情别名解析、转换
## 使用说明
### 安装依赖
```bash
yarn add @znlbwo/wechat-emoji
```
### 示例
[Demo](./demo)
## API 说明
### WechatEmojiPanel
> 微信 emoji 表情面板类
将生成的表情面板 Element 插入指定的 el 容器元素。
| 属性 | 类型 | 描述 |
| -------- | -------- | ------------------------------------------------ |
| el | Element | 表情面板容器元素 |
| onSelect | Function | 点击选中表情的回调函数，参数：点击选中的表情别名 |
### convertAlt2Emoji
> 将表情别名转换为 img element
传入表情别名，返回 img element
### convertText2Emoji
> 将文本中的表情别名转换为 img element
传入一段文本，返回一段带 img element 的文本。