fan-chat

介绍

基于vue2.x 聊天(IM)UI组件

演示

[Demo]

安装

npm install fan-chat

全局安装

import Vue from 'vue'
import FanChat from 'fan-chat'

Vue.use(FanChat)

局部安装

import FanChat from 'fan-chat'

export default {
  components: {
    FanChat
  }
}

功能

• [x] 文字展示（支持html标签渲染）
• [x] 图片展示和预览
• [x] 视频播放
• [x] 语音播放
• [x] 自定义默认头像
• [x] 下拉加载更多
• [x] 图片/视频/语音发送功能和UI

预览

![main]

Demo

 <fan-chat
      ref="mChat"
      :messages="messages"
      @submit="submit"
      :loadMore="loadMore"
      height="100vh"
    >
    </fan-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()解密 | | config | Object | - | 详情参见config | | placeholder | String | - | 回复框placeholder |

config

{
         /**
          * 主题 'light'(亮色)|'dark'(暗色)
          */
         theme: 'light',
        /**
         * 图片上传
         */
        image: {
          /**
           * 上传大小最大值(kb)
           */
          maxSize: 500,
          /**
           * 允许的文件类型
           */
          accept: ['image/*']
        },
        /**
         * 文件上传
         */
        file: {
          maxSize: 500,
          accept: ['*']
        },
        /**
         * 视频上传
         */
        video: {
          maxSize: 500,
          accept: ['video/*']
        },
        /**
         * 是否开启图片预览 默认true
         */
        isImagePreview: true,
         /**
         * 图片预览配置（兼容vant ImagePreview 配置）
         */
        imagePreviewConfig: {
          closeable: false
        },
        /**
         * 是否开启已读未读
         */
         read:false
}

消息对象

 {
    id: null, // 唯一id
    name: "", // 姓名
    avatar: "", // 头像地址
    self: false, // 是否是自己
    content:{
            text: "", // 文本
            duration: "", // 时长
            imageUrl: "", // 图片地址
            videoUrl: "", // 视频地址
            audioUrl: "", // 音频地址
            fileUrl: "", // 文件地址
            fileName: "", // 文件名称
            fileSize: "", // 文件大小
            fileExt: "", // 文件扩展名
    },
    type: "text", // 文件类型:text|image|audio|video|file,
    isCancel:false // 控制该消息是否已经撤回,
    time:'' // 发送时间
 }

事件

| 事件名 | 说明 | 回调参数 | | ------------ | ---------------------------------------- | ------------------------------------------------------- | | submit | 文字、图片、视频、语音、文件等等发送事件 | (content:{type:string, content:object}) | | popItemClick | 气泡框点击事件 | (obj:{type:string, data:object}) | | recordStart | 录音开始 | - | | recordStop | 录音停止 | ({ blob, duration})--H5录音才有回调参数，自定义录音没有 | | recordCancel | 录音取消 | - |

popItemClick Demo

     popItemClick(obj) {
      // 撤回
      if (obj.type == "cancel") {
        obj.data.isCancel = true;
      }
      console.log(obj);
    }

Slots（废弃）

| 名称 | 说明 | 参数 | | ----- | ---------- | ---- | | left | 输入框左边 | - | | right | 输入框右边 | - |

方法

通过 ref 可以获取到 mChat 实例并调用实例方法

| 方法名 | 说明 | 参数 | 返回值 | | ------------ | ---------------------------------------------- | -------------- | ------ | | toggleExtend | 控制扩展面板, 通过参数可以控制是否展示扩展面板 | (flag:boolean) | - |

常见问题

如何自定义扩展面板item

模板

  <m-chat ref="mChat" :config="config"
      @extendItemClick="extendItemClick">
    </m-chat>

配置

 config: {
        /**
         * 需展示的扩展面板item
         */
        openExtends: ['image', 'video', 'file', 'custom'],
        /**
         * 需额外添加的扩展面板item
         * 如需自定义图标参考vant-icon文档 https://vant-contrib.gitee.io/vant/v2/#/zh-CN/icon#zi-ding-yi-tu-biao
         */
        extendArr: [{
          type: "custom",
          text: "位置",
          icon: "location-o",
          classPrefix: 'van-icon',
        },]
      },

回调

extendItemClick(item) {
      console.log('扩展面板item点击了', item)
      if (item.type == 'custom') {
        // 控制扩展面板显示和隐藏
        this.$refs.mChat.toggleExtend();
      }

完全自定义扩展面板

<m-chat>
   <template #extend>
        自定义扩展面板
   </template>
</m-chat>

LICENSE