修复切换联系人但消息未变的错误,增加自定义聊天工具栏,增加快捷发送,优化文档

This commit is contained in:
fan
2021-01-17 00:26:29 +08:00
parent a450101dbe
commit d81c431315
12 changed files with 721 additions and 340 deletions
+558 -27
View File
@@ -1,5 +1,12 @@
<template>
<div id="app">
<div class="logo">
<div class="logo-text"><b>Lemon</b> IMUI<span class="logo-badge">{{this.packageData.version}}</span></div>
<div class="logo-sub">{{this.packageData.description}}</div>
<div class="link"><span>源码下载&nbsp;&nbsp;</span><a target="_blank" href="https://github.com/fanjyy/lemon-imui">Github</a><a target="_blank" href="https://gitee.com/june000/lemon-im">Gitee</a></div>
</div>
<div class="imui-center">
<lemon-imui
:user="user"
@@ -16,7 +23,7 @@
<template #cover>
<div class="cover">
<i class="lemon-icon-message"></i>
<p><b>Lemon</b> IMUI</p>
<p><b>自定义封面 Lemon</b> IMUI</p>
</div>
</template>
<!-- <template #contact-info="contact">
@@ -37,6 +44,8 @@
</template>
</lemon-imui>
<div class="action">
<lemon-button @click="appendMessage">发送消息</lemon-button>
<lemon-button @click="updateContact">修改联系人信息</lemon-button>
@@ -46,15 +55,438 @@
>
</div>
<div class="link">
<a target="_blank" href="https://github.com/fanjyy/lemon-imui">Github</a>
<a target="_blank" href="https://gitee.com/june000/lemon-im">Gitee</a>
</div>
</div>
<div class="title">联系人 Contact</div>
<table class="table">
<tr class="table-head">
<th>参数</th>
<th>说明</th>
<th>类型</th>
<th>默认值</th>
<th>示例</th>
</tr>
<tr>
<td width="150">id</td>
<td width="350">唯一ID</td>
<td width="150">String/Number</td>
<td width="100">-</td>
<td></td>
</tr>
<tr>
<td>displayName</td>
<td>名称</td>
<td>String</td>
<td>-</td>
<td></td>
</tr>
<tr>
<tr>
<td>avatar</td>
<td>头像</td>
<td>String</td>
<td>-</td>
<td></td>
</tr>
<tr>
<td>type</td>
<td>会话类型单聊single | 群聊many</td>
<td>String</td>
<td>-</td>
<td></td>
</tr>
<tr>
<td>index</td>
<td>通讯录索引传入字母或数字进行排序索引可以显示自定义文字[A]最近联系人</td>
<td>String</td>
<td>-</td>
<td></td>
</tr>
<tr>
<td>unread</td>
<td>未读消息数</td>
<td>Number</td>
<td>0</td>
<td></td>
</tr>
<tr>
<td>lastSendTime</td>
<td>最近一条消息的时间戳</td>
<td>timestamp</td>
<td>0</td>
<td></td>
</tr>
<tr>
<td>lastSendTime</td>
<td>最近一条消息的内容</td>
<td>String | Vnode</td>
<td></td>
<td></td>
</tr>
</table>
<div class="title">消息体 Message</div>
<table class="table">
<tr class="table-head">
<th>参数</th>
<th>说明</th>
<th>类型</th>
<th>默认值</th>
<th>示例</th>
</tr>
<tr>
<td width="150">id</td>
<td width="350">唯一ID</td>
<td width="150">String/Number</td>
<td width="100">-</td>
<td></td>
</tr>
<tr>
<td>status</td>
<td>消息发送的状态going | failed | succeed</td>
<td>String</td>
<td>-</td>
<td></td>
</tr>
<tr>
<tr>
<td>type</td>
<td>消息类型voice | file | video | image | text</td>
<td>String</td>
<td>-</td>
<td></td>
</tr>
<tr>
<td>sendTime</td>
<td>消息发送时间</td>
<td>timestamp</td>
<td>-</td>
<td></td>
</tr>
<tr>
<td>content</td>
<td>消息内容如果type=file此属性表示文件的URL地址</td>
<td>String</td>
<td>-</td>
<td></td>
</tr>
<tr>
<td>fileSize</td>
<td>文件大小</td>
<td>Number</td>
<td>0</td>
<td></td>
</tr>
<tr>
<td>fileName</td>
<td>文件名称</td>
<td>String</td>
<td>-</td>
<td></td>
</tr>
<tr>
<td>toContactId</td>
<td>接收消息的联系人ID</td>
<td>String | Number</td>
<td>-</td>
<td></td>
</tr>
<tr>
<td>fromUser</td>
<td>消息发送人的信息</td>
<td>Object</td>
<td>-</td>
<td>{id: "1",displayName: "测试",avatar: "url"};</td>
</tr>
</table>
<div class="title">组件属性</div>
<table class="table">
<tr class="table-head">
<th>参数</th>
<th>说明</th>
<th>类型</th>
<th>默认值</th>
<th>示例</th>
</tr>
<tr>
<td width="150">user</td>
<td width="350">用户信息</td>
<td width="150">Object</td>
<td width="100">-</td>
<td>{id: "1",displayName: "测试",avatar: "url"};</td>
</tr>
<tr>
<td>messageTimeFormat</td>
<td>消息列表时间格式化函数</td>
<td>Function(time)=>String</td>
<td>-</td>
<td>
</td>
</tr>
<tr>
<td>contactTimeFormat</td>
<td>联系人时间格式化规则</td>
<td>Function(time)=>String</td>
<td>-</td>
<td></td>
</tr>
<tr>
<td>hideDrawer</td>
<td>是否隐藏抽屉</td>
<td>Boolean</td>
<td>true</td>
<td></td>
</tr>
<tr>
<td>hideMenuAvatar</td>
<td>是否隐藏导航头像</td>
<td>Boolean</td>
<td>false</td>
<td></td>
</tr>
<tr>
<td>hideMenu</td>
<td>是否隐藏左侧导航</td>
<td>Boolean</td>
<td>false</td>
<td></td>
</tr>
</table>
<div class="title">组件方法</div>
<table class="table">
<tr class="table-head">
<th>参数</th>
<th>说明</th>
<th>类型</th>
<th>默认值</th>
<th>示例</th>
</tr>
<tr>
<td width="150">initMenus</td>
<td width="350">初始化导航</td>
<td width="150">Function([Object])</td>
<td width="100">-</td>
<td></td>
</tr>
<tr>
<td>initContacts</td>
<td>初始化联系人</td>
<td>Function([Contact])</td>
<td>-</td>
<td>
</td>
</tr>
<tr>
<td>initEmoji</td>
<td>初始化表情数据</td>
<td>Function([Object])</td>
<td>-</td>
<td>
<div>
有分类[{
label: '默认表情',
children: [
{
name: '1f62c',
title: '微笑',
src: 'https://twemoji.maxcdn.com/2/72x72/1f62c.png'
}
]
}]
</div>
<div>
无分类[{
name: '1f62c',
title: '微笑',
src: 'https://twemoji.maxcdn.com/2/72x72/1f62c.png'
}]
</div>
</td>
</tr>
<tr>
<td>appendMessage</td>
<td>在当前聊天窗口插入一条新消息, scrollToBottom=true 添加之后滚动到消息窗口底部</td>
<td>Function(Message,scrollToBottom=false)</td>
<td>-</td>
<td></td>
</tr>
<tr>
<td>removeMessage</td>
<td>删除聊天消息</td>
<td>Function(Message.id,Contact.id)</td>
<td>-</td>
<td></td>
</tr>
<tr>
<td>updateMessage</td>
<td>修改一条消息</td>
<td>Function(Message.id,Contact.id,Message)</td>
<td>-</td>
<td></td>
</tr>
<tr>
<td>updateMessage</td>
<td>修改联系人</td>
<td>Function(Contact.id,Contact)</td>
<td>-</td>
<td></td>
</tr>
<tr>
<td>getMessages</td>
<td>返回所有本地消息传入 Contact.id 则只返回与该联系人的消息</td>
<td>Function(Contact.id)=>[Message]</td>
<td>-</td>
<td></td>
</tr>
<tr>
<td>getContacts</td>
<td>返回所有本地联系人</td>
<td>Function()=>[Contact]</td>
<td>-</td>
<td></td>
</tr>
<tr>
<td>openDrawer</td>
<td>打开联系人右侧抽屉vnode 为抽屉内容</td>
<td>Function(vnode)</td>
<td>-</td>
<td></td>
</tr>
<tr>
<td>changeDrawer</td>
<td>切换右侧抽屉显示/隐藏vnode 为抽屉内容</td>
<td>Function(vnode)</td>
<td>-</td>
<td></td>
</tr>
<tr>
<td>closeDrawer</td>
<td>关闭抽屉</td>
<td>Function()</td>
<td>-</td>
<td></td>
</tr>
<tr>
<td>changeMenu</td>
<td>切换左侧导航</td>
<td>Function(Menu.name)</td>
<td>-</td>
<td></td>
</tr>
<tr>
<td>changeContact</td>
<td>切换聊天窗口</td>
<td>Function(Contact.id)</td>
<td>-</td>
<td></td>
</tr>
<tr>
<td>messageViewToBottom</td>
<td>将当前聊天窗口滚动到底部</td>
<td>Function()</td>
<td>-</td>
<td></td>
</tr>
<tr>
<td>setLastContentRender</td>
<td>设置左侧联系人最新消息的渲染函数</td>
<td>Function(Message.type, (Message)=>vnode)</td>
<td>-</td>
<td>
setLastContentRender('image', message => {
return <span>[最新图片]</span>
})
</td>
</tr>
<tr>
<td>lastContentRender</td>
<td>用来生成 Message.lastContent 需要的vnode结构</td>
<td>Function(Message)</td>
<td>-</td>
<td></td>
</tr>
</table>
<div class="title">组件插槽</div>
<table class="table">
<tr class="table-head">
<th>插槽名</th>
<th>说明</th>
<th>参数</th>
</tr>
<tr>
<td width="150">cover</td>
<td width="350">初始化时的封面</td>
<td width="150">-</td>
</tr>
<tr>
<td width="150">contact-title</td>
<td width="350">联系人标题</td>
<td width="150">Contact</td>
</tr>
<tr>
<td width="150">message-sidebar</td>
<td width="350">左侧消息列表的顶部</td>
<td width="150">-</td>
</tr>
<tr>
<td width="150">contact-sidebar</td>
<td width="350">左侧联系人列表的顶部</td>
<td width="150">-</td>
</tr>
<tr>
<td width="150">contact-info</td>
<td width="350">左侧联系人详细页</td>
<td width="150">Contact</td>
</tr>
</table>
<div class="title">组件事件</div>
<table class="table">
<tr class="table-head">
<th>事件名</th>
<th>说明</th>
<th>参数</th>
</tr>
<tr>
<td width="150">change-menu</td>
<td width="350">当左侧导航选项卡切换的时候会触发该事件</td>
<td width="150">Menu.name</td>
</tr>
<tr>
<td width="150">menu-avatar-click</td>
<td width="350">当左侧导航内的头像被点击时回触发该事件</td>
<td width="150">Contact</td>
</tr>
<tr>
<td width="150">change-contact</td>
<td width="350">当左侧联系人点击时会触发该事件</td>
<td width="150">Contact</td>
</tr>
<tr>
<td width="150">pull-messages</td>
<td width="350">当切换聊天对象或者聊天窗口滚动到顶部时会触发该事件调用next方法结束loading状态如果设置了isEnd=true下次聊天窗口滚动到顶部将不会再触发该事件</td>
<td width="150">Contact,next([Message],isEnd)</td>
</tr>
<tr>
<td width="150">message-click</td>
<td width="350">点击聊天窗口中的消息时会触发该事件</td>
<td width="150">event,key,Message</td>
</tr>
<tr>
<td width="150">send</td>
<td width="350">当发送一条新消息时会触发该事件</td>
<td width="150">Message,Function(Message)调用该函数完成消息发送可以传入Message来改变消息内容file上传时的文件</td>
</tr>
</table>
</div>
</template>
<script>
import packageData from '../package.json';
const getTime = () => {
return new Date().getTime();
};
@@ -93,6 +525,7 @@ export default {
name: "app",
data() {
return {
packageData,
hideMenuAvatar: false,
hideMenu: false,
user: {
@@ -104,6 +537,7 @@ export default {
};
},
mounted() {
const contactData1 = {
id: "contact-1",
displayName: "工作协作群",
@@ -143,6 +577,7 @@ export default {
const { IMUI } = this.$refs;
let data = [
{ ...contactData1 },
{ ...contactData2 },
@@ -211,6 +646,51 @@ export default {
isBottom: true
}
]);
IMUI.initEditorTools([
{
name:'emoji',
},
{
name:'uploadFile',
},
{
name:'uploadImage',
},
{
name:"test1",
click:()=>{
IMUI.$refs.editor.selectFile("application/vnd.ms-excel")
},
render:()=>{
return <span>Excel</span>
}
},
{
name:"test1",
click:()=>{
IMUI.initEditorTools([
{name:'uploadFile'},
{name:'emoji'}
]);
},
render:()=>{
return <span>重制工具栏</span>
}
},
{
name:"test2",
isRight:true,
title:'上传 Excel',
click:()=>{
alert('点击了 ··· ')
},
render:()=>{
return <b>···</b>
}
},
]);
IMUI.initEmoji([
{
label: "表情",
@@ -538,7 +1018,7 @@ export default {
...message.fromUser,
...this.user
};
IMUI.appendMessage(message);
IMUI.appendMessage(message,true);
IMUI.updateContact(contact.id, {
unread: "+1",
lastSendTime: getTime(),
@@ -574,7 +1054,6 @@ export default {
this.$refs.IMUI.closeDrawer();
},
handleSend(message, next, file) {
//console.log("Event:send");
console.log(message,next,file)
setTimeout(() => {
next();
@@ -583,10 +1062,9 @@ export default {
handlePullMessages(contact, next) {
const { IMUI } = this.$refs;
const otheruser = {
id: "hehe",
displayName: "I KNOEW",
avatar:
"https://ss3.bdstatic.com/70cFv8Sh_Q1YnxGkpoWK1HF6hhy/it/u=4085009425,1005454674&fm=26&gp=0.jpg"
id: contact.id,
displayName: contact.displayName,
avatar:contact.avatar
};
console.log("Event:pull-messages");
const messages = [
@@ -618,28 +1096,81 @@ export default {
</script>
<style lang="stylus">
::selection{background:#000;color:#fff;}
body
background #3d495c !important
background #f6f6f6 !important
#app
width 90%
margin 0 auto
padding-bottom 100px
.action
margin-top 20px
.lemon-button
margin-right 10px
.link
padding 15px 0
font-size 14px
margin-top 15px
a
display inline-block
font-size 16px
color #ccd3dc
margin 0 5px
text-decoration none
border-radius 5px
margin-right 15px
&:hover
color #85acda
.action
margin-top 30px
button
margin-right 10px
.imui-center
background #ffba00
border-radius 4px
padding 5px 10px
color rgba(0,0,0,0.8)
.logo
position relative
display inline-block
margin 60px auto
user-select none
.logo-text
font-size 38px
.logo-sub
font-size 18px
color #999
font-weight 300
.logo-badge
position absolute
top 50%
left 50%
transform translate(-50%,-50%)
top -10px
right -40px
background #000
border-radius 16px
color #f9f9f9
font-size 12px
padding 4px 8px
.title
font-size 24px
line-height 26px
border-left 1px solid #ffba00
padding-left 15px
margin-bottom 15px
margin-top 30px
user-select none
.table
width 100%
border-radius 10px
background #fff
border-collapse collapse
tr
cursor pointer
tr:not(.table-head):hover
background #ffba00 !important
tr:nth-of-type(even)
background #f9f9f9
th
user-select none
color #999
td,
th
text-align left
padding 10px 15px
font-size 14px
font-weight normal
.imui-center
margin-bottom 60px
.lemon-wrapper,
.lemon-wrapper--drawer-show .lemon-drawer
box-shadow 0 0 30px rgba(0,0,0,0.1);
.drawer-content
padding 15px
.more