1.1.10 • Published 2 years ago
yxy-m-chat v1.1.10
介绍
基于 vue2.x 聊天(IM)UI 组件(3.x 以后支持)
演示
安装
npm install @maybecode/m-chat全局安装
import Vue from 'vue'
import MChat from '@maybecode/m-chat'
Vue.use(MChat)局部安装
import MChat from '@maybecode/m-chat'
export default {
components: {
MChat
}
}功能
- 文字展示（支持 html 标签渲染）
- 图片展示和预览
- 视频播放
- 语音播放
- 自定义默认头像
- 下拉加载更多
- 图片/视频/语音发送功能和 UI
预览
Demo
<m-chat
ref="mChat"
:messages="messages"
@submit="submit"
:loadMore="loadMore"
height="100vh"
>
</m-chat>Props
| 参数 | 类型 | 默认值 | 说明 | |
|---|---|---|---|---|
| messages | Array | [] | 消息数组 | |
| height | String | 100vh | 容器高度 | |
| loadMore | Function | - | 加载更多函数 | |
| defaultAvatar | String | - | 默认头像(支持本地头像 require 导入或者地址) | |
| comment | Boolean | true | 是否显示回复框 | |
| openPops | Array | 'copy','cancel' | 气泡框内显示的功能 例: 'copy','cancel' | |
| customRecord | Boolean | flase | 自定义录音功能(设置为 true 后自带录音失效，并且不触发 submit 事件) | |
| openExtends | Array | "image", "file", "video" | 扩展面板显示的功能 | |
| openBases | Array | "text", "audio", "emoji" | 控制基础功能显示 | |
| imgMaxSize | Number | 500 | 图片大小上传限制(kb) | |
| videoMaxSize | Number | 500 | 视频大小上传限制(kb) | |
| fileMaxSize | Number | 500 | 文件大小上传限制(kb) | |
| leadPage | String | - | 微信公众号网页下载引导页面,例: http://www.xxx.com/leadPage 会跳转到 http://www.xxx.com/leadPage?url='xxx'&name='xxxxx', 注意:参数需要用 decodeComponent()解密 |
消息对象
{
id: null, // 唯一id
name: "", // 姓名
avatar: "", // 头像地址
self: false, // 是否是自己
content:{
text: "", // 文本
duration: "", // 时长
imageUrl: "", // 图片地址
videoUrl: "", // 视频地址
audioUrl: "", // 音频地址
fileUrl: "", // 文件地址
fileName: "", // 文件名称
fileSize: "", // 文件大小
fileExt: "", // 文件扩展名
// 产品链接对象
href:{
id: "",
img:"",
title: "",
brand: "",
classification: "",
specifications: "",
model: "",
maker: ""
},
// 文字链接对象
links:[{text:"",url:""}],
},
type: "text", // 文件类型:text|image|audio|video,
isCancel:false // 控制该消息是否已经撤回,
isError:false // 控制过长时间没有回复的提示,
time:'' // 发送时间
}事件
| 事件名 | 说明 | 回调参数 |
|---|---|---|
| submit | 文字、图片、视频、语音等等发送事件 | (content:{type:string,content:object}) |
| popItemClick | 气泡框点击事件 | (obj:{type:string,data:object}) |
| recordStart | 录音开始 | - |
| recordStop | 录音停止 | ({ blob, duration})--H5 录音才有回调参数，自定义录音没有 |
| recordCancel | 录音取消 | - |
| hrefClick | 产品链接点击事件 | - |
| linkClick | 文字链接点击事件 | - |
popItemClick Demo
popItemClick(obj) {
// 撤回
if (obj.type == "cancel") {
obj.data.isCancel = true;
}
console.log(obj);
}Slots
| 名称 | 说明 | 参数 |
|---|---|---|
| left | 输入框左边 | - |
| right | 输入框右边 | - |
方法
通过 ref 可以获取到 mChat 实例并调用实例方法
| 方法名 | 说明 | 参数 | 返回值 |
|---|---|---|---|
| toggleExtend | 控制扩展面板,通过参数可以控制是否展示扩展面板 | (flag:boolean) | - |
LICENSE
版权所有 Copyright © by 或许