消息栏

Framework7 附带了一个特殊的可调整大小的工具栏,可用于搭配 消息 来使用

消息栏布局

消息栏布局非常简单

<div class="toolbar messagebar">
  <div class="toolbar-inner">
    <div class="messagebar-area">
      <!-- messagebar attachments -->
      <div class="messagebar-attachments">...</div>
      <!-- messagebar resizable textarea -->
      <textarea class="resizable" placeholder="Message"></textarea>
    </div>
    <a href="#" class="link">Send</a>
  </div>
  <!-- messagebar sheet -->
  <div class="messagebar-sheet">...</div>
</div>

其中

消息栏的位置非常重要,它应处于 page 中且 page-content 之前

<div class="page">
  <!-- navbar -->
  <div class="navbar">...</div>

  <!-- messagebar -->
  <div class="toolbar messagebar">...</div>

  <!-- page-content/messages-content -->
  <div class="page-content messages-content">
    ... messages
  </div>
</div>

消息栏页布局

如果需要附加页,例如可以附加到消息中的图片,那么我们使用专门为此设计的额外块

<div class="messagebar-sheet">
  <!-- selectable sheet image -->
  <label class="checkbox messagebar-sheet-image" style="background-image:url(path/to/image1.png)">
    <input type="checkbox" />
    <i class="icon icon-checkbox"></i>
  </label>

  <!-- another selectable sheet image -->
  <label class="checkbox messagebar-sheet-image" style="background-image:url(path/to/image2.png)">
    <input type="checkbox" />
    <i class="icon icon-checkbox"></i>
  </label>

  <!-- some custom sheet item -->
  <div class="messagebar-sheet-item">
    <!-- any custom content here -->
  </div>
</div>

消息栏附件布局

消息附件块旨在显示当前附加的消息项目/图片

<div class="messagebar-attachments">
  <!-- image attachment -->
  <div class="messagebar-attachment">
    <img src="path/to/image1.png" />
  </div>

  <!-- deletable image attachment -->
  <div class="messagebar-attachment">
    <img src="path/to/image2.png" />
    <!-- attachment delete button -->
    <span class="messagebar-attachment-delete"></span>
  </div>
</div>

消息栏应用方法

现在,当我们拥有消息栏' HTML 时,我们需要初始化它。我们需要使用相关的应用方法

app.messagebar.create(parameters)使用参数初始化消息栏
  • parameters - object - 带消息栏参数的对象
  • 方法返回已初始化的消息栏实例
app.messagebar.destroy(el)销毁消息栏实例
  • el - HTMLElementstring(带 CSS 选择器)或 object。要销毁的消息栏元素或消息栏实例。
app.messagebar.get(el)按 HTML 元素获取消息栏实例
  • el - HTMLElementstring(带 CSS 选择器)。消息栏元素。
  • 方法返回消息栏'实例

消息栏参数

我们来看看所有可用参数列表

参数类型默认值描述
elstring
HTMLElement
消息栏元素的 CSS 选择器或 HTML 元素(div class="messagebar"
textareaElstring
HTMLElement
消息栏文本区域元素的 CSS 选择器或 HTML 元素。默认情况下(如果未传递),会尝试在消息栏内查找 textarea
maxHeightnumbernull当根据其文本量调整文本区域大小时,它的最大高度
attachmentsarray[]带附件的数组。例如 ['path/to/image1.png', 'path/to/image2.png']
resizePagebooleantrue当更改消息栏文本区域大小时,如果不想调整消息页面,请禁用此功能
onobject

带有事件处理程序的对象。例如

var messagebar = app.messagebar.create({
  el: '.messagebar',
  on: {
    change: function () {
      console.log('Textarea value changed')
    }
  }
})
渲染函数
renderAttachmentsfunction(attachments)渲染附件块的函数。必须返回完整的附件 HTML 字符串
renderAttachmentfunction(attachment)渲染单个附件的函数。必须返回完整的附件 HTML 字符串

消息栏方法 & 属性

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

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

在我们初始化消息栏之后,在变量中(如上述示例中的 messagebar 变量)中获得了它的已初始化实例,其中包含有用的方法和属性

属性
messagebar.elMessagebar HTML 元素。
messagebar.$el包含 messagebar HTML 元素的 Dom7 元素。
messagebar.textareaElMessagebar textarea HTML 元素
messagebar.$textareaEl包含 messagebar textarea HTML 元素的 Dom7 元素
messagebar.params包含传入初始化参数的对象
messagebar.attachments包含 messagebar 附件的数组
方法
messagebar.getValue();获取 messagebar textarea 值
messagebar.setValue(value);设置 messagebar textarea 值/文本
messagebar.clear();清空 textarea 并更新/重置其大小
messagebar.focus();将焦点放在 messagebar textarea
messagebar.blur();从 messagebar textarea 中移除焦点
messagebar.setPlaceholder(placeholder)设置/更改 messagebar 占位符文本
messagebar.resizePage()强制 Messagebar 根据 messagebar 高度/大小调整消息页面大小
messagebar.attachmentsCreate()动态创建附件块 HTML 元素
messagebar.attachmentsShow()显示附件块
messagebar.attachmentsHide()隐藏附件块
messagebar.attachmentsToggle()切换附件块
messagebar.renderAttachments()根据附件数据呈现附件块
messagebar.sheetCreate()动态创建 messagebar 表格块 HTML 元素
messagebar.sheetShow()显示 messagebar 表格
messagebar.sheetHide()隐藏 messagebar 表格
messagebar.sheetToggle()切换 messagebar 表格
messagebar.destroy();销毁 messagebar 实例

Messagebar 事件

Messagebar 将触发 messagebar 元素上的以下 DOM 事件以及 App 和 messagebar 实例上的事件

DOM 事件

事件目标描述
messagebar:changemessagebar 元素<div class="messagebar">在 messagebar textarea 值更改后触发事件
messagebar:focusmessagebar 元素<div class="messagebar">当 messagebar textarea 获得焦点时触发事件
messagebar:blurmessagebar 元素<div class="messagebar">当 messagebar textarea 失去焦点时触发事件
messagebar:resizepagemessagebar 元素<div class="messagebar">当 messagebar 调整消息页面大小时触发事件
messagebar:attachmentdeleteMessagebar 附件元素<div class="messagebar-attachment">在点击 messagebar 附件删除按钮后触发事件
messagebar:attachmentclickMessagebar 附件元素<div class="messagebar-attachment">在 messagebar 附件点击时触发事件
messagebar:beforedestroymessagebar 元素<div class="messagebar">在 Messagebar 实例被销毁之前触发事件

App 和 Messagebar 实例事件

Messagebar 实例会同时向其自身的实例和 App 实例发出事件。App 实例事件具有相同的前缀名称messagebar

事件目标参数描述
changemessagebar(messagebar)在 messagebar textarea 值更改后触发事件。事件处理程序收到 messagebar 实例作为参数
messagebarChangeapp
focusmessagebar(messagebar)当 messagebar textarea 获得焦点时触发事件。事件处理程序收到 messagebar 实例作为参数
messagebar焦点app
失焦messagebar(messagebar)当聊天消息框输入框失去焦点时会触发事件,事件处理程序会接收聊天消息框实例作为参数
聊天消息框失焦app
resizePagemessagebar(messagebar)当聊天消息框调整消息页面时会触发事件,事件处理程序会接收聊天消息框实例作为参数
聊天消息框调整页面app
附件删除messagebar(聊天消息框、附件 HTML 元素、附件索引号)点击聊天消息框附件删除按钮后会触发事件,事件处理程序会接收聊天消息框实例、已点击的附件 HTML 元素和附件索引号作为参数
聊天消息框附件删除app
附件点击messagebar(聊天消息框、附件 HTML 元素、附件索引号)点击聊天消息框附件时会触发事件,事件处理程序会接收聊天消息框实例、已点击的附件 HTML 元素和附件索引号作为参数
聊天消息框附件点击app
销毁之前messagebar(messagebar)在 Messagebar 实例被销毁之前触发事件
聊天消息框销毁之前app

聊天消息框自动初始化

如果您不需要使用聊天消息框 API,而且聊天消息框位于页面内部并在页面初始化时显示在 DOM 中,则可以通过向聊天消息框元素添加额外的 messagebar-init 类即可自动初始化该聊天消息框,所有必需的参数都可以使用 data- 属性传递

<div class="toolbar messagebar messagebar-init" data-max-height="200">
  <div class="toolbar-inner">
    <div class="messagebar-area">
      <textarea placeholder="Message"></textarea>
    </div>
    <a href="#" class="link">Send</a>
  </div>
</div>

对 camelCase 中使用的参数(例如 maxHeight),在 data- 属性中应使用 kebab-case(例如 data-max-height

CSS 变量

以下是相关 CSS 变量(CSS 自定义属性)的列表。

请注意,带注释的变量在默认情况下未指定,并且其值是它们在此情况下回退到的值。

:root {
  --f7-messagebar-attachments-height: 155px;
  --f7-messagebar-sheet-height: 252px;
  --f7-messagebar-sheet-landscape-height: 192px;
  /*
  --f7-messagebar-inner-padding-left: var(--f7-toolbar-inner-padding-left);
  --f7-messagebar-inner-padding-right: var(--f7-toolbar-inner-padding-right);
  */
}
.ios {
  --f7-messagebar-height: 44px;
  --f7-messagebar-font-size: 17px;
  --f7-messagebar-textarea-bg-color: transparent;
  /*
  --f7-messagebar-link-color: var(--f7-theme-color);
  */
  --f7-messagebar-border-color: transparent;
  --f7-messagebar-textarea-border-radius: 17px;
  --f7-messagebar-textarea-padding: 6px 16px;
  --f7-messagebar-textarea-height: 34px;
  --f7-messagebar-textarea-font-size: 17px;
  --f7-messagebar-textarea-line-height: 20px;
  --f7-messagebar-sheet-bg-color: #d1d5da;
  --f7-messagebar-sheet-border-color: transparent;
  --f7-messagebar-attachment-border-radius: 12px;
  --f7-messagebar-attachment-height: 155px;
  --f7-messagebar-attachment-landscape-height: 120px;
  --f7-messagebar-textarea-placeholder-color: rgba(0, 0, 0, 0.4);
  --f7-messagebar-textarea-text-color: #000;
  --f7-messagebar-textarea-border: 1px solid #c8c8cd;
  --f7-messagebar-attachments-border-color: #c8c8cd;
  --f7-messagebar-bg-color: #fff;
  --f7-messagebar-bg-color-rgb: 255, 255, 255;
}
.ios .dark,
.ios.dark {
  --f7-messagebar-textarea-placeholder-color: rgba(255, 255, 255, 0.4);
  --f7-messagebar-textarea-text-color: #fff;
  --f7-messagebar-textarea-border: 1px solid var(--f7-bars-border-color);
  --f7-messagebar-attachments-border-color: var(--f7-bars-border-color);
  --f7-messagebar-bg-color: var(--f7-bars-bg-color);
  --f7-messagebar-bg-color-rgb: var(--f7-bars-bg-color-rgb);
}
.md {
  --f7-messagebar-height: 64px;
  --f7-messagebar-font-size: 16px;
  --f7-messagebar-textarea-border-radius: 24px;
  --f7-messagebar-textarea-padding: 12px 16px;
  --f7-messagebar-textarea-height: 48px;
  --f7-messagebar-textarea-font-size: 16px;
  --f7-messagebar-textarea-line-height: 22px;
  --f7-messagebar-textarea-border: 1px solid transparent;
  --f7-messagebar-attachment-border-radius: 12px;
  --f7-messagebar-attachment-height: 72px;
  --f7-messagebar-attachment-landscape-height: 72px;
  --f7-messagebar-border-color: transparent;
  --f7-messagebar-attachments-border-color: transparent;
}
.md,
.md .dark,
.md [class*='color-'] {
  --f7-messagebar-textarea-placeholder-color: var(--f7-md-on-surface-variant);
  --f7-messagebar-textarea-bg-color: var(--f7-md-surface-variant);
  --f7-messagebar-bg-color: var(--f7-md-surface);
  --f7-messagebar-textarea-text-color: var(--f7-md-on-surface);
  --f7-messagebar-sheet-bg-color: var(--f7-md-surface);
  --f7-messagebar-sheet-border-color: var(--f7-md-outline-variant);
  --f7-messagebar-link-color: var(--f7-md-on-surface);
}

示例

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>