訊息列

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 - 物件 - 包含訊息列參數的物件
  • 方法傳回已初始化的訊息列執行個體
app.messagebar.destroy(el)銷毀訊息列執行個體
  • el - HTMLElement字串 (含 CSS 選擇器) 或 物件。要銷毀的訊息列元素或訊息列執行個體。
app.messagebar.get(el)透過 HTML 元素取得訊息列執行個體
  • el - HTMLElement字串 (含 CSS 選擇器)。訊息列元素。
  • 方法傳回訊息列的執行個體

訊息列參數

讓我們看看所有可用參數的清單

參數類型預設值說明
el字串
HTMLElement
訊息列元素的 CSS 選擇器或 HTML 元素 (div class="messagebar")
textareaEl字串
HTMLElement
訊息列文字區域元素的 CSS 選擇器或 HTML 元素。預設 (如果未傳遞) 將嘗試在訊息列內尋找 textarea
maxHeight數字null文字區域在根據其文字量調整大小時的最高高度
attachments陣列[]包含附件的陣列。例如 ['path/to/image1.png', 'path/to/image2.png']
resizePage布林值true如果您不希望在訊息列文字區域大小變更時調整訊息頁面大小,請停用
on物件

包含事件處理常式的物件。例如

var messagebar = app.messagebar.create({
  el: '.messagebar',
  on: {
    change: function () {
      console.log('Textarea value changed')
    }
  }
})
渲染函式
renderAttachments函式(attachments)用於渲染附件區塊的函式。必須傳回完整的附件 HTML 字串
renderAttachment函式(attachment)用於渲染單一附件的函式。必須傳回完整的附件 HTML 字串

訊息列方法和屬性

因此,要建立訊息列,我們必須呼叫

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

初始化訊息列後,我們在變數中取得其初始化的執行個體 (例如上方範例中的 messagebar 變數),其中包含有用的方法和屬性

屬性
messagebar.el訊息列 HTML 元素。
messagebar.$el包含訊息列 HTML 元素的 Dom7 元素。
messagebar.textareaEl訊息列文字區域 HTML 元素
messagebar.$textareaEl包含訊息列文字區域 HTML 元素的 Dom7 元素
messagebar.params包含傳遞初始化參數的物件
messagebar.attachments包含訊息列附件的陣列
方法
messagebar.getValue();取得訊息列文字區域值
messagebar.setValue(value);設定訊息列文字區域值/文字
messagebar.clear();清除文字區域並更新/重設其大小
messagebar.focus();讓訊息列文字區域取得焦點
messagebar.blur();從訊息列文字區域移除焦點
messagebar.setPlaceholder(placeholder)設定/變更訊息列提示文字
messagebar.resizePage()強制訊息列根據訊息列高度/大小調整訊息頁面大小
messagebar.attachmentsCreate()動態建立附件區塊 HTML 元素
messagebar.attachmentsShow()顯示附件區塊
messagebar.attachmentsHide()隱藏附件區塊
messagebar.attachmentsToggle()切換附件區塊
messagebar.renderAttachments()根據附件資料呈現附件區塊
messagebar.sheetCreate()動態建立訊息欄工作表區塊 HTML 元素
messagebar.sheetShow()顯示訊息欄工作表
messagebar.sheetHide()隱藏訊息欄工作表
messagebar.sheetToggle()切換訊息欄工作表
messagebar.destroy();銷毀訊息欄執行個體

訊息欄事件

訊息欄會在訊息欄元素上觸發下列 DOM 事件,並在應用程式和訊息欄執行個體上觸發事件

DOM 事件

事件目標說明
messagebar:change訊息欄元素<div class="messagebar">訊息欄文字方塊值變更後會觸發事件
messagebar:focus訊息欄元素<div class="messagebar">訊息欄文字方塊取得焦點時會觸發事件
messagebar:blur訊息欄元素<div class="messagebar">訊息欄文字方塊失去焦點時會觸發事件
messagebar:resizepage訊息欄元素<div class="messagebar">訊息欄調整訊息頁面大小時會觸發事件
messagebar:attachmentdelete訊息欄附件元素<div class="messagebar-attachment">按一下訊息欄附件刪除按鈕後會觸發事件
messagebar:attachmentclick訊息欄附件元素<div class="messagebar-attachment">按一下訊息欄附件時會觸發事件
messagebar:beforedestroy訊息欄元素<div class="messagebar">訊息欄執行個體即將被銷毀前會觸發事件

應用程式和訊息欄執行個體事件

訊息欄執行個體會在自身執行個體和應用程式執行個體上發出事件。應用程式執行個體事件名稱相同,但前面加上 messagebar

事件目標引數說明
changemessagebar(messagebar)訊息欄文字方塊值變更後會觸發事件。事件處理常式會收到訊息欄執行個體作為引數
messagebarChangeapp
focusmessagebar(messagebar)訊息欄文字方塊取得焦點時會觸發事件。事件處理常式會收到訊息欄執行個體作為引數
messagebarFocusapp
blurmessagebar(messagebar)訊息欄文字方塊失去焦點時會觸發事件。事件處理常式會收到訊息欄執行個體作為引數
messagebarBlurapp
resizePagemessagebar(messagebar)訊息欄調整訊息頁面大小時會觸發事件。事件處理常式會收到訊息欄執行個體作為引數
messagebarResizePageapp
附件刪除messagebar(訊息列,附件元素,附件索引)在訊息列附件刪除按鈕上按一下後,將觸發事件。作為引數,事件處理常式會收到訊息列執行個體、按一下的附件 HTML 元素和附件索引號碼
訊息列附件刪除app
附件按一下messagebar(訊息列,附件元素,附件索引)在訊息列附件上按一下後,將觸發事件。作為引數,事件處理常式會收到訊息列執行個體、按一下的附件 HTML 元素和附件索引號碼
訊息列附件按一下app
在銷毀之前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 Variables

以下是相關 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>