消息
消息组件将帮助您在应用中实现评论和消息系统的可视化。
消息布局
<div class="page">
<div class="page-content messages-content">
<div class="messages">
<!-- Date stamp -->
<div class="messages-title"><b>Sunday, Feb 9</b> 12:58</div>
<!-- Sent message (by default - green and on right side) -->
<div class="message message-sent">
<div class="message-content">
<!-- Bubble with text -->
<div class="message-bubble">
<div class="message-text">Hi, Kate</div>
</div>
</div>
</div>
<!-- Another sent message -->
<div class="message message-sent">
<div class="message-content">
<div class="message-bubble">
<div class="message-text">How are you?</div>
</div>
</div>
</div>
<!-- Received message (by default - grey on left side) -->
<div class="message message-received">
<!-- Sender avatar -->
<div class="message-avatar" style="background-image:url(path/to/avatar.jpg)"></div>
<div class="message-content">
<!-- Sender name -->
<div class="message-name">Blue Ninja</div>
<!-- Bubble with text -->
<div class="message-bubble">
<div class="message-text">Hi there, I am also fine, thanks! And how are you?</div>
</div>
</div>
</div>
</div>
</div>
</div>
消息页面布局:
messages-content
- 消息包装器所需的额外类。应添加到page-content
messages
- 消息气泡所需的额外包装器。必需元素。messages-title
- 消息标题message
- 单条消息
单个消息布局
这里是完整的单条消息布局:
<div class="message">
<div class="message-avatar" style="background-image:url(path/to/avatar)"></div>
<div class="message-content">
<div class="message-name">John Doe</div>
<div class="message-header">Message header</div>
<div class="message-bubble">
<div class="message-text-header">Text header</div>
<div class="message-image">
<img src="path/to/image" />
</div>
<div class="message-text">Hello world!</div>
<div class="message-text-footer">Text footer</div>
</div>
<div class="message-footer">Message footer</div>
</div>
</div>
message-avatar
- 发送者头像,可选message-name
- 发送者名称,可选message-header
- 单条消息头部,可选message-text-header
- 气泡内的文本头部,可选message-image
- 消息图片,可选message-text
- 消息文本,可选message-text-footer
- 气泡内的文本尾部,可选message-footer
- 气泡后的尾部文本,可选
单条消息容器的额外类
message-sent
- 指示此消息由用户发送的额外类。它位于右侧,带有绿色背景颜色。message-received
- 指示此消息由用户接收的额外类。它位于左侧,带有灰色背景颜色。message-tail
- 指示单条消息(接收或发送)以添加气泡“尾部”的额外类message-same-name
- 指示消息与上一条消息具有相同发送者名称的额外类message-same-avatar
- 指示消息与上一条消息具有相同头像的额外类message-same-header
- 指示消息与上一条消息具有相同消息头部的额外类message-same-footer
- 指示消息与上一条消息具有相同消息尾部的额外类message-last
- 指示单条消息(接收或发送)以指示当前对话中由一个发送者接收或发送的最后一条消息的额外类message-first
- 指示单条消息(接收或发送)以指示当前对话中由一个发送者接收或发送的第一条消息的额外类
消息应用程序方法
现在,当我们有消息的HTML时,我们需要初始化它。我们需要使用相关的应用方法:
app.messages.create(参数) | 使用参数初始化消息
|
app.messages.destroy(el) | 销毁消息实例
|
app.messages.get(el) | 通过HTML元素获取消息实例
|
消息参数
让我们查看所有可用参数的列表:
参数 | 类型 | 默认 | 描述 |
---|---|---|---|
autoLayout | 布尔值 | true | 启用自动布局以根据传递的条件自动添加所有必需的额外类 |
newMessagesFirst | 布尔值 | false | 如果你想在顶部使用新消息,而不是在底部使用,请启用此选项 |
scrollMessages | 布尔值 | true | 在添加新消息时启用/禁用消息自动滚动 |
scrollMessagesOnEdge | 布尔值 | true | 如果启用,则消息自动滚动仅在用户位于消息视图的顶部/底部时发生 |
messages | 数组 | 初始消息的数组。数组中的每条消息应表示为具有单条消息参数的对象 | |
on | 对象 | 带有事件处理程序的对象。例如:
| |
renderMessage | 函数(message) | 渲染单条消息的函数。必须返回完整消息HTML字符串 | |
自动布局条件 | |||
firstMessageRule | 函数(message, previousMessage, nextMessage) | 必须返回布尔值的函数true 或false 基于上一条和下一条消息的所需条件。如果匹配,则message-first 将添加到消息的类 | |
lastMessageRule | 函数(message, previousMessage, nextMessage) | 必须返回布尔值的函数true 或false 基于上一条和下一条消息的所需条件。如果匹配,则message-last 将添加到消息的类 | |
tailMessageRule | 函数(message, previousMessage, nextMessage) | 必须返回布尔值的函数true 或false 基于上一条和下一条消息的所需条件。如果匹配,则message-tail 将添加到消息的类 | |
sameNameMessageRule | 函数(message, previousMessage, nextMessage) | 必须返回布尔值的函数true 或false 基于上一条和下一条消息的所需条件。如果匹配,则message-same-name 将添加到消息的类 | |
sameHeaderMessageRule | 函数(message, previousMessage, nextMessage) | 必须返回布尔值的函数true 或false 基于上一条和下一条消息的所需条件。如果匹配,则message-same-header 将添加到消息的类 | |
sameFooterMessageRule | 函数(message, previousMessage, nextMessage) | 必须返回布尔值的函数true 或false 基于上一条和下一条消息的所需条件。如果匹配,则message-same-footer 将添加到消息的类 | |
sameAvatarMessageRule | 函数(message, previousMessage, nextMessage) | 必须返回布尔值的函数true 或false 基于上一条和下一条消息的所需条件。如果匹配,则message-same-avatar 将添加到消息的类 | |
customClassMessageRule | 函数(message, previousMessage, nextMessage) | 必须返回额外消息类作为字符串的函数,基于上一条和下一条消息的所需条件。 |
单个消息参数
让我们看看当我们传递messages
数组时应该使用的单条消息参数对象
参数 | 类型 | 默认 | 描述 |
---|---|---|---|
text | 字符串 | 消息文本 | |
头部 | 字符串 | 单条消息头部 | |
尾部 | 字符串 | 单条消息尾部 | |
name | 字符串 | 发送者名称 | |
头像 | 字符串 | 发送者头像URL字符串 | |
type | 字符串 | sent | 消息类型 -sent 或received |
textHeader | 字符串 | 消息文本标题 | |
textFooter | 字符串 | 消息文本页脚 | |
图片 | 字符串 | 消息图片HTML字符串,例如<img src="path/to/image" /> . 可以代替imageSrc parameter | |
imageSrc | 字符串 | 消息图片URL字符串。可以代替image parameter | |
isTitle | 布尔值 | 定义是否应将其渲染为消息或消息标题 | |
cssClass | 字符串 | 应设置在消息HTML元素上的额外CSS类 | |
attrs | 对象 | 要设置在消息HTML元素上的附加HTML属性的对象。例如,要设置额外data 属性,它应该看起来像:
|
消息方法和属性
因此,要创建消息,我们必须调用:
var messages = app.messages.create({ /* parameters */ })
初始化消息后,我们在变量中拥有其初始化的实例(例如messages
上面示例中的变量)中具有其初始化实例,带有有用的方法和属性:
属性 | |
---|---|
messages.params | 包含传递的初始化参数的对象 |
messages.el | 消息容器HTML元素(<div class="messages"> ) |
messages.$el | 带有 messages HTML 元素的 Dom7 元素 |
messages.messages | 包含 messages 的数组 |
方法 | |
messages.showTyping(message) | 显示正在输入的消息指示器
|
messages.hideTyping() | 隐藏正在输入的消息指示器 |
messages.addMessage(message, 方法设置的过滤项目, animate); | 根据参数将新消息添加到末尾或开头。必需。方法设置的过滤项目parameter
|
messages.addMessages(messages, 方法设置的过滤项目, animate); | 一次性添加多个消息。
|
messages.removeMessage(message); | 移除消息
|
messages.removeMessages(messages); | 移除多个消息
|
messages.scroll(持续时间,位置); | 根据滚动持续时间(毫秒)将消息滚动到顶部/底部newMessagesFirst parameter
|
messages.renderMessages() | 根据消息布局渲染 HTMLmessages 数组 |
messages.layout(); | 强制消息自动布局 |
messages.clear(); | 清除/移除所有消息 |
messages.destroy(); | 销毁消息实例 |
消息事件
消息将在消息元素和应用程序和消息实例上触发以下 DOM 事件:
DOM 事件
事件 | Target | 描述 |
---|---|---|
messages:beforedestroy | 消息元素<div class="messages"> | 在消息实例被销毁之前将触发此事件 |
应用程序和消息实例事件
消息实例在自身实例和应用程序实例上发出事件。应用程序实例事件具有相同的前缀,前缀为messages
.
事件 | Target | 参数 | 描述 |
---|---|---|---|
beforeDestroy | messages | (messages) | 在消息实例被销毁之前将触发此事件 |
messagesBeforeDestroy | app |
消息自动初始化
如果您不需要使用消息 API,并且您的消息在页面内,并且在页面初始化时在 DOM 中显示,则可以通过添加额外的messages-init
类到消息元素来自动初始化,并且所有必需的参数都可以使用data-
属性指定所有参数来自动初始化:
<div class="messages messages-init" data-new-messages-first="true">
...
</div>
camelCase中使用的参数,例如newMessagesFirst,在data-属性中应使用kebab-case作为data-new-messages-first
CSS 变量
以下是相关CSS 变量(CSS 自定义属性) 的列表。
注意,注释掉的变量默认未指定,其值在这种情况下是它们回退到的值。
:root {
--f7-message-text-header-opacity: 0.65;
--f7-message-text-header-font-size: 12px;
--f7-message-text-footer-opacity: 0.65;
--f7-message-text-footer-font-size: 12px;
--f7-message-bubble-line-height: 1.2;
--f7-message-header-font-size: 12px;
--f7-message-footer-font-size: 11px;
--f7-message-name-font-size: 12px;
--f7-message-name-font-weight: inherit;
--f7-message-avatar-border-radius: 50%;
--f7-messages-title-font-weight: inherit;
--f7-message-typing-indicator-bg-color: #000;
}
:root .dark,
:root.dark {
--f7-message-typing-indicator-bg-color: #fff;
}
.ios {
--f7-message-text-header-text-color: inherit;
--f7-message-text-footer-text-color: inherit;
--f7-messages-title-font-size: 11px;
--f7-message-avatar-size: 29px;
--f7-message-margin: 10px;
--f7-message-bubble-min-height: 32px;
--f7-message-bubble-font-size: 17px;
--f7-message-bubble-border-radius: 16px;
--f7-message-bubble-padding-vertical: 6px;
--f7-message-bubble-padding-horizontal: 16px;
--f7-message-typing-indicator-opacity: 0.35;
/*
--f7-message-sent-bg-color: var(--f7-theme-color);
*/
--f7-message-sent-text-color: #fff;
--f7-messages-content-bg-color: #fff;
--f7-message-received-text-color: #000;
--f7-message-received-bg-color: #e5e5ea;
--f7-messages-title-text-color: rgba(0, 0, 0, 0.45);
--f7-message-header-text-color: rgba(0, 0, 0, 0.45);
--f7-message-footer-text-color: rgba(0, 0, 0, 0.45);
--f7-message-name-text-color: rgba(0, 0, 0, 0.45);
}
.ios .dark,
.ios.dark {
--f7-message-received-bg-color: #252525;
--f7-message-received-text-color: #fff;
--f7-messages-content-bg-color: transparent;
--f7-messages-title-text-color: rgba(255, 255, 255, 0.54);
--f7-message-header-text-color: rgba(255, 255, 255, 0.54);
--f7-message-name-text-color: rgba(255, 255, 255, 0.54);
--f7-message-footer-text-color: rgba(255, 255, 255, 0.54);
}
.md {
--f7-messages-content-bg-color: transparent;
--f7-messages-title-font-size: 12px;
--f7-message-avatar-size: 32px;
--f7-message-margin: 16px;
--f7-message-bubble-min-height: 40px;
--f7-message-bubble-font-size: 16px;
--f7-message-bubble-border-radius: 20px;
--f7-message-bubble-padding-vertical: 10px;
--f7-message-bubble-padding-horizontal: 16px;
--f7-message-typing-indicator-opacity: 0.6;
}
.md,
.md .dark,
.md [class*='color-'] {
--f7-message-sent-bg-color: var(--f7-md-primary);
--f7-message-sent-text-color: var(--f7-md-on-primary);
--f7-message-received-bg-color: var(--f7-md-surface-variant);
--f7-message-received-text-color: var(--f7-md-on-surface);
--f7-message-text-header-text-color: var(--f7-md-on-surface-variant);
--f7-message-text-footer-text-color: var(--f7-md-on-surface-variant);
--f7-messages-title-text-color: var(--f7-md-on-surface-variant);
--f7-message-header-text-color: var(--f7-md-on-surface-variant);
--f7-message-footer-text-color: var(--f7-md-on-surface-variant);
--f7-message-name-text-color: var(--f7-md-on-surface-variant);
}
示例
<template>
<div class="page">
<div class="navbar">
<div class="navbar-bg"></div>
<div class="navbar-inner sliding">
<div class="title">Messages</div>
</div>
</div>
<div class="toolbar messagebar" @messagebar:attachmentdelete=${deleteAttachment}>
<div class="toolbar-inner">
<a class="link icon-only" @click=${sheetToggle}>
<i class="icon f7-icons if-not-md">camera_fill</i>
<i class="icon material-icons md-only">camera_alt</i>
</a>
<div class="messagebar-area">
<textarea class="resizable" placeholder="Message"></textarea>
</div>
<a class="link icon-only demo-send-message-link" @click=${sendMessage}>
<i class="icon f7-icons if-not-md">arrow_up_circle_fill</i>
<i class="icon material-icons md-only">send</i>
</a>
</div>
<div class="messagebar-sheet">
${images.map((image) => $h`
<label class="checkbox messagebar-sheet-image" @change=${handleAttachment}>
<input type="checkbox" />
<i class="icon icon-checkbox"></i>
<img src=${image} />
</label>
`)}
</div>
</div>
<div class="page-content messages-content">
<div class="messages">
<div class="messages-title"><b>Sunday, Feb 9,</b> 12:58</div>
<div class="message message-sent">
<div class="message-content">
<div class="message-bubble">
<div class="message-text">Hi, Kate</div>
</div>
</div>
</div>
<div class="message message-sent">
<div class="message-content">
<div class="message-bubble">
<div class="message-text">How are you?</div>
</div>
</div>
</div>
<div class="message message-received">
<div class="message-avatar"
style="background-image:url(https://cdn.framework7.io/placeholder/people-100x100-9.jpg)"></div>
<div class="message-content">
<div class="message-name">Kate</div>
<div class="message-bubble">
<div class="message-text">Hi, I am good!</div>
</div>
</div>
</div>
<div class="message message-received">
<div class="message-avatar"
style="background-image:url(https://cdn.framework7.io/placeholder/people-100x100-7.jpg)"></div>
<div class="message-content">
<div class="message-name">Blue Ninja</div>
<div class="message-bubble">
<div class="message-text">Hi there, I am also fine, thanks! And how are you?</div>
</div>
</div>
</div>
<div class="message message-sent">
<div class="message-content">
<div class="message-bubble">
<div class="message-text">Hey, Blue Ninja! Glad to see you ;)</div>
</div>
</div>
</div>
<div class="message message-sent">
<div class="message-content">
<div class="message-bubble">
<div class="message-text">Hey, look, cutest kitten ever!</div>
</div>
</div>
</div>
<div class="message message-sent">
<div class="message-content">
<div class="message-bubble">
<div class="message-image">
<img src="https://cdn.framework7.io/placeholder/cats-200x260-4.jpg"
style="width:200px; height: 260px" />
</div>
</div>
</div>
</div>
<div class="message message-received">
<div class="message-avatar"
style="background-image:url(https://cdn.framework7.io/placeholder/people-100x100-9.jpg)"></div>
<div class="message-content">
<div class="message-name">Kate</div>
<div class="message-bubble">
<div class="message-text">Nice!</div>
</div>
</div>
</div>
<div class="message message-received">
<div class="message-avatar"
style="background-image:url(https://cdn.framework7.io/placeholder/people-100x100-9.jpg)"></div>
<div class="message-content">
<div class="message-name">Kate</div>
<div class="message-bubble">
<div class="message-text">Like it very much!</div>
</div>
</div>
</div>
<div class="message message-received">
<div class="message-avatar"
style="background-image:url(https://cdn.framework7.io/placeholder/people-100x100-7.jpg)"></div>
<div class="message-content">
<div class="message-name">Blue Ninja</div>
<div class="message-bubble">
<div class="message-text">Awesome!</div>
</div>
</div>
</div>
</div>
</div>
</div>
</template>
<script>
export default (props, { $f7, $el, $on, $ }) => {
const images = [
'https://cdn.framework7.io/placeholder/cats-300x300-1.jpg',
'https://cdn.framework7.io/placeholder/cats-200x300-2.jpg',
'https://cdn.framework7.io/placeholder/cats-400x300-3.jpg',
'https://cdn.framework7.io/placeholder/cats-300x150-4.jpg',
'https://cdn.framework7.io/placeholder/cats-150x300-5.jpg',
'https://cdn.framework7.io/placeholder/cats-300x300-6.jpg',
'https://cdn.framework7.io/placeholder/cats-300x300-7.jpg',
'https://cdn.framework7.io/placeholder/cats-200x300-8.jpg',
'https://cdn.framework7.io/placeholder/cats-400x300-9.jpg',
'https://cdn.framework7.io/placeholder/cats-300x150-10.jpg'
];
const people = [
{
name: 'Kate Johnson',
avatar: 'https://cdn.framework7.io/placeholder/people-100x100-9.jpg'
},
{
name: 'Blue Ninja',
avatar: 'https://cdn.framework7.io/placeholder/people-100x100-7.jpg'
},
];
const answers = [
'Yes!',
'No',
'Hm...',
'I am not sure',
'And what about you?',
'May be ;)',
'Lorem ipsum dolor sit amet, consectetur',
'What?',
'Are you sure?',
'Of course',
'Need to think about it',
'Amazing!!!',
];
let responseInProgress = false;
let messagebar;
let messages;
const sheetToggle = () => {
messagebar.sheetToggle();
}
const deleteAttachment = (e, index) => {
var image = messagebar.attachments.splice(index, 1)[0];
messagebar.renderAttachments();
checkAttachments();
// Uncheck in sheet
var imageIndex = images.indexOf(image);
$el.value.find('.messagebar-sheet .checkbox').eq(imageIndex).find('input').prop('checked', false);
}
const handleAttachment = (e) => {
var index = $(e.target).parents('label.checkbox').index();
var image = images[index];
if (e.target.checked) {
// Add to attachments
messagebar.attachments.unshift(image)
} else {
// Remove from attachments
messagebar.attachments.splice(messagebar.attachments.indexOf(image), 1);
}
messagebar.renderAttachments();
checkAttachments();
}
const checkAttachments = () => {
if (messagebar.attachments.length > 0) {
messagebar.attachmentsShow();
messagebar.setPlaceholder('Add comment or Send');
} else {
messagebar.attachmentsHide();
messagebar.setPlaceholder('Message');
}
}
const sendMessage = () => {
var text = messagebar.getValue().replace(/\n/g, '<br />').trim();
var messagesToSend = [];
messagebar.attachments.forEach(function (attachment) {
var size = attachment.split('placeholder/cats-')[1].split('-')[0].split('x');
messagesToSend.push({
image: '<img src="' + attachment + '" style="width: ' + (size[0] / 2) + 'px; height: ' + (size[1] / 2) + 'px">'
});
});
if (text.trim().length) {
messagesToSend.push({
text: text
});
}
// Reset attachments
messagebar.attachments = [];
checkAttachments();
// Hide sheet
messagebar.sheetHide();
// Uncheck selected images in sheet
messagebar.$sheetEl.find('input').prop('checked', false);
// Clear area
messagebar.clear();
// Focus area
if (text.length) messagebar.focus();
// Exit when nothing to send
if (!messagesToSend.length) return;
// Send message
messages.addMessages(messagesToSend);
// Mock response
if (responseInProgress) return;
responseInProgress = true;
setTimeout(function () {
var answer = answers[Math.floor(Math.random() * answers.length)];
var person = people[Math.floor(Math.random() * people.length)];
messages.showTyping({
header: person.name + ' is typing',
avatar: person.avatar
});
setTimeout(function () {
messages.addMessage({
text: answer,
type: 'received',
name: person.name,
avatar: person.avatar
});
messages.hideTyping();
responseInProgress = false;
}, 4000);
}, 1000);
}
$on('pageInit', () => {
messagebar = $f7.messagebar.create({
el: $el.value.find('.messagebar'),
attachments: []
});
messages = $f7.messages.create({
el: $el.value.find('.messages'),
firstMessageRule: function (message, previousMessage, nextMessage) {
if (message.isTitle) return false;
if (!previousMessage || previousMessage.type !== message.type || previousMessage.name !== message.name) return true;
return false;
},
lastMessageRule: function (message, previousMessage, nextMessage) {
if (message.isTitle) return false;
if (!nextMessage || nextMessage.type !== message.type || nextMessage.name !== message.name) return true;
return false;
},
tailMessageRule: function (message, previousMessage, nextMessage) {
if (message.isTitle) return false;
if (!nextMessage || nextMessage.type !== message.type || nextMessage.name !== message.name) return true;
return false;
}
});
})
$on('pageBeforeRemove', () => {
messagebar.destroy()
messages.destroy()
})
return $render;
};
</script>