消息

Messages 组件可以帮助你在应用中可视化评论和消息系统。

消息布局

<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>

消息页面布局

单个消息布局

下面是完整的单个消息布局

<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>

单个消息容器的附加类

消息应用程序方法

现在,有了消息的 HTML,我们需要对其进行初始化。我们需要使用相关的应用程序方法

app.messages.create(parameters)用参数初始化消息
  • parameters - 对象 - 包含消息参数的对象
  • 该方法返回已初始化的消息实例
app.messages.destroy(el)销毁消息实例
  • el - HTMLElement字符串(带 CSS 选择器)或 对象。要销毁的消息元素或消息实例。
app.messages.get(el)按 HTML 元素获取消息实例
  • el - HTMLElement字符串(带 CSS 选择器)。消息元素。
  • 该方法返回消息实例

消息参数

我们来看一看目前可用的全部参数

参数类型默认值说明
autoLayoutbooleantrue启用自动布局以根据传递的条件自动添加所有必要的附加类
newMessagesFirstbooleanfalse启用此设置,如果你想在顶部看到新消息,而不要在底部看到
scrollMessagesbooleantrue启用/禁用在添加新消息时自动滚动
scrollMessagesOnEdgebooleantrue启用此设置,当用户位于消息视图的顶部/底部时,才会自动滚动消息
messages数组包含初始消息的数组。数组中的每条消息应呈现为包含 单条消息参数 的对象
on对象

包含事件处理程序的对象。例如

var messages = app.messages.create({
  el: '.messages',
  on: {
    change: function () {
      console.log('Textarea value changed')
    }
  }
})
renderMessagefunction(message)呈现单条消息的函数。必须返回完整的 HTML 消息字符串
自动布局条件
firstMessageRulefunction(message, previousMessage, nextMessage)根据上条和下条消息返回布尔值 truefalse 的函数,要求满足条件。匹配时,将向消息添加 message-first
lastMessageRulefunction(message, previousMessage, nextMessage)根据上条和下条消息返回布尔值 truefalse 的函数,要求满足条件。匹配时,将向消息添加 message-last
tailMessageRulefunction(message, previousMessage, nextMessage)根据上条和下条消息返回布尔值 truefalse 的函数,要求满足条件。匹配时,将向消息添加 message-tail
sameNameMessageRulefunction(message, previousMessage, nextMessage)根据上条和下条消息返回布尔值 truefalse 的函数,要求满足条件。匹配时,将向消息添加 message-same-name
sameHeaderMessageRulefunction(message, previousMessage, nextMessage)根据上条和下条消息返回布尔值 truefalse 的函数,要求满足条件。匹配时,将向消息添加 message-same-header
sameFooterMessageRulefunction(message, previousMessage, nextMessage)根据上条和下条消息返回布尔值 truefalse 的函数,要求满足条件。匹配时,将向消息添加 message-same-footer
sameAvatarMessageRulefunction(message, previousMessage, nextMessage)根据上条和下条消息返回布尔值 truefalse 的函数,要求满足条件。匹配时,将向消息添加 message-same-avatar
customClassMessageRulefunction(message, previousMessage, nextMessage)根据上条和下条消息返回额外消息类作为字符串的函数,要求满足条件。

单条消息参数

让我们看看我们在传递 messages 数组时应使用的单条消息参数对象

参数类型默认值说明
text字符串消息文本
header字符串单条消息标题
footer字符串单条消息页脚
name字符串发件人姓名
avatar字符串发件人头像 URL 字符串
type字符串sent消息类型 - sentreceived
textHeader字符串消息文本标题
textFooter字符串消息文本页脚
image字符串消息图像 HTML 字符串,例如 <img src="path/to/image" />。可替代 imageSrc 参数使用
imageSrc字符串消息图像 URL 字符串。可替代 image 参数使用
isTitleboolean定义是否应将其呈现为消息或消息标题
cssClass字符串要设置在消息 HTML 元素上的其他 CSS 类
attrs对象包含要设置在消息 HTML 元素上的其他 HTML 属性的对象。例如,要设置额外的 data 属性,应如下所示
var message = {
  text: 'Hello!',
  attrs: {
    'data-id': 1,
    'data-author-id': 150
  }
}

消息方法和属性

因此,要创建消息,我们必须调用

var messages = app.messages.create({ /* parameters */ })

在初始化消息后,我们在变量中(如上面示例中的 messages 变量)及其初始化的实例中拥有有用的方法和属性

属性
messages.params包含已传初始化参数的对象
messages.el消息容器 HTML 元素(<div class="messages">
messages.$el包含消息 HTML 元素的 Dom7 元素
messages.messages包含消息的数组
方法
messages.showTyping(message)显示正在键入消息指示器
messages.hideTyping()隐藏正在键入消息指示器
messages.addMessage(message, method, animate);

根据 method 参数将新消息添加到末尾或开头

  • message - object - 要添加的消息参数。必需的。
  • method - string - (appendprepend) 指示将新消息添加到消息容器的末尾或开头。可选;如果未指定,则会根据 newMessagesFirst 参数添加消息
  • animate - boolean - (默认为 true)你可以在此处传递 false,并且消息将立即添加,而不会出现任何转换或滚动动画。可选。
  • 方法返回消息实例
messages.addMessages(messages, method, animate);同时添加多条消息。
  • messages - array,包含要添加的消息。数组中的每条消息均应表示为具有 消息参数 的对象。必需的。
  • 方法返回消息实例
messages.removeMessage(message);移除消息
  • message - 要移除的消息的 HTMLElementstring(带 CSS 选择器)或 number(带从 messages 数组中获取的消息的索引号)
  • 方法返回消息实例
messages.removeMessages();移除多条消息
  • messages - array 包含要移除的消息
  • 方法返回消息实例
messages.scroll(duration, position);根据 newMessagesFirst 参数将消息滚动到顶部/底部
  • duration - number 以毫秒为单位的滚动持续时间
  • position - number 以 px 为单位的滚动位置
messages.renderMessages()根据 messages 数组渲染消息 HTML
messages.layout();强制消息自动布局
messages.clear();清除/移除所有消息
messages.destroy();销毁消息实例

消息事件

消息将在消息元素上触发以下 DOM 事件,并在应用程序和消息实例上触发事件

DOM 事件

事件目标说明
messages:beforedestroy消息元素<div class="messages">在消息实例被销毁之前触发事件

应用程序和消息实例事件

消息实例在自身实例和应用程序实例上发出事件。应用程序实例事件具有相同名称,前缀为 messages

事件目标参数说明
beforeDestroymessages(messages)在消息实例被销毁之前触发事件
messagesBeforeDestroyapp

消息自动初始化

如果您不需要使用消息 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);
}

示例

messages.html
<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>