訊息元件
訊息 React 元件代表 訊息 元件。
訊息元件
包含以下元件
訊息
- 主要訊息容器訊息
- 單一訊息元素訊息標題
- 單一訊息標題元素
訊息屬性
屬性 | 類型 | 預設值 | 說明 |
---|---|---|---|
<Messages> 屬性 | |||
init | 布林值 | true | 初始化訊息元件 |
newMessagesFirst | 布林值 | false | 啟用此選項,可將新訊息顯示在最上方,而不是最下方 |
scrollMessages | 布林值 | true | 啟用/停用在新增新訊息時自動捲動訊息 |
scrollMessagesOnEdge | 布林值 | true | 如果啟用,則只有當使用者在訊息檢視的最上方/最下方時,才會自動捲動訊息 |
typing | 布林值 | false | 允許顯示/切換輸入訊息指示器 |
<Message> 屬性 | |||
type | 字串 | sent | 訊息類型:sent (預設值)或 received |
text | 字串 | 訊息文字 | |
avatar | 字串 | 訊息使用者的頭像網址 | |
name | 字串 | 訊息使用者的姓名 | |
image | 字串 | 訊息圖片網址 | |
header | 字串 | 訊息標頭 | |
footer | 字串 | 訊息尾端 | |
textHeader | 字串 | 訊息文字標頭 | |
textFooter | 字串 | 訊息文字尾端 | |
first | 布林值 | false | 定義訊息為對話中的第一則 |
last | 布林值 | false | 定義訊息為對話中的最後一則 |
tail | 布林值 | false | 定義訊息具有視覺上的「尾巴」。通常是對話中的最後一則訊息 |
sameName | 布林值 | false | 定義此訊息的發送者姓名與前一則訊息相同 |
sameHeader | 布林值 | false | 定義此訊息的標頭文字與前一則訊息相同 |
sameFooter | 布林值 | false | 定義此訊息的尾端文字與前一則訊息相同 |
sameAvatar | 布林值 | false | 定義此訊息使用者的頭像網址與前一則訊息相同 |
訊息事件
事件 | 說明 |
---|---|
<Message> 事件 | |
click | 當使用者按一下訊息泡泡時,將觸發事件 |
clickName | 當使用者按一下訊息使用者的姓名時,將觸發事件 |
clickText | 當使用者按一下訊息文字時,將觸發事件 |
clickAvatar | 當使用者按一下訊息使用者的頭像時,將觸發事件 |
clickHeader | 當使用者按一下訊息標頭時,將觸發事件 |
clickFooter | 當使用者按一下訊息尾端時,將觸發事件 |
clickBubble | 當使用者按一下訊息泡泡時,將觸發事件 |
訊息插槽
單一訊息 React 元件 (<Message>
) 有額外的插槽可供自訂元素使用
default
- 元素會插入在<div class="message-bubble">
元素的子元素中start
- 元素會插入在開頭,並成為主要訊息元素<div class="message">
的直接子元素end
- 元素會插入在結尾,並成為主要訊息元素<div class="message">
的直接子元素content-start
- 元素會插入在開頭,並成為<div class="message-content">
元素的直接子元素content-end
- 元素會插入在結尾,並成為<div class="message-content">
元素的直接子元素bubble-start
- 元素會插入在開頭,並成為<div class="message-bubble">
元素的直接子元素bubble-end
- 元素會插入在結尾,並成為<div class="message-bubble">
元素的直接子元素。與default
插槽相同
如果需要傳遞更複雜的版面,可以在單一訊息中使用以下插槽,取代相同的道具
header
- 元素會插入在訊息標題中footer
- 元素會插入在訊息頁尾中text
- 元素會插入在訊息文字中name
- 元素會插入在訊息名稱中image
- 元素會插入在訊息圖片中(假設為<img>
元素)text-header
- 元素會插入在訊息文字標題中text-footer
- 元素會插入在訊息文字頁尾中
<Message
type="sent"
text="Hello World"
name="John Doe"
avatar="path/to/image.jpg"
>
<div slot="start">Start</div>
<div slot="end">End</div>
<div slot="content-start">Content Start</div>
<div slot="content-end">Content End</div>
<div slot="bubble-start">Bubble Start</div>
<div slot="bubble-end">Bubble End</div>
</Message>
{/* Renders to: */}
<div class="message message-sent">
<div>Start</div>
<div class="message-avatar" style="background-image: url(path/to/image.jpg);"></div>
<div class="message-content">
<div>Content Start</div>
<div class="message-name">John Doe</div>
<div class="message-bubble">
<div>Bubble Start</div>
<div class="message-text">Hello World</div>
<div>Bubble End</div>
</div>
<div>Content End</div>
</div>
<div>End</div>
</div>
範例
以下是訊息頁面的完整範例,可與 訊息列 搭配使用
messages.jsx
import React, { useEffect, useRef, useState } from 'react';
import {
Navbar,
Page,
Messages,
MessagesTitle,
Message,
Messagebar,
Link,
MessagebarAttachments,
MessagebarAttachment,
MessagebarSheet,
MessagebarSheetImage,
f7ready,
f7,
} from 'framework7-react';
export default () => {
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!!!',
];
const [attachments, setAttachments] = useState([]);
const [sheetVisible, setSheetVisible] = useState(false);
const [typingMessage, setTypingMessage] = useState(null);
const [messageText, setMessageText] = useState('');
const [messagesData, setMessagesData] = useState([
{
type: 'sent',
text: 'Hi, Kate',
},
{
type: 'sent',
text: 'How are you?',
},
{
name: 'Kate',
type: 'received',
text: 'Hi, I am good!',
avatar: 'https://cdn.framework7.io/placeholder/people-100x100-9.jpg',
},
{
name: 'Blue Ninja',
type: 'received',
text: 'Hi there, I am also fine, thanks! And how are you?',
avatar: 'https://cdn.framework7.io/placeholder/people-100x100-7.jpg',
},
{
type: 'sent',
text: 'Hey, Blue Ninja! Glad to see you ;)',
},
{
type: 'sent',
text: 'Hey, look, cutest kitten ever!',
},
{
type: 'sent',
image: 'https://cdn.framework7.io/placeholder/cats-200x260-4.jpg',
},
{
name: 'Kate',
type: 'received',
text: 'Nice!',
avatar: 'https://cdn.framework7.io/placeholder/people-100x100-9.jpg',
},
{
name: 'Kate',
type: 'received',
text: 'Like it very much!',
avatar: 'https://cdn.framework7.io/placeholder/people-100x100-9.jpg',
},
{
name: 'Blue Ninja',
type: 'received',
text: 'Awesome!',
avatar: 'https://cdn.framework7.io/placeholder/people-100x100-7.jpg',
},
]);
const responseInProgress = useRef(false);
const messagebar = useRef(null);
const attachmentsVisible = () => {
return attachments.length > 0;
};
const placeholder = () => {
return attachments.length > 0 ? 'Add comment or Send' : 'Message';
};
useEffect(() => {
f7ready(() => {
messagebar.current = f7.messagebar.get('.messagebar');
});
});
const isFirstMessage = (message, index) => {
const previousMessage = messagesData[index - 1];
if (message.isTitle) return false;
if (
!previousMessage ||
previousMessage.type !== message.type ||
previousMessage.name !== message.name
)
return true;
return false;
};
const isLastMessage = (message, index) => {
const nextMessage = messagesData[index + 1];
if (message.isTitle) return false;
if (!nextMessage || nextMessage.type !== message.type || nextMessage.name !== message.name)
return true;
return false;
};
const isTailMessage = (message, index) => {
const nextMessage = messagesData[index + 1];
if (message.isTitle) return false;
if (!nextMessage || nextMessage.type !== message.type || nextMessage.name !== message.name)
return true;
return false;
};
const deleteAttachment = (image) => {
const index = attachments.indexOf(image);
attachments.splice(index, 1);
setAttachments([...attachments]);
};
const handleAttachment = (e) => {
const index = f7.$(e.target).parents('label.checkbox').index();
const image = images[index];
if (e.target.checked) {
// Add to attachments
attachments.unshift(image);
} else {
// Remove from attachments
attachments.splice(attachments.indexOf(image), 1);
}
setAttachments([...attachments]);
};
const sendMessage = () => {
const text = messageText.replace(/\n/g, '<br>').trim();
const messagesToSend = [];
attachments.forEach((attachment) => {
messagesToSend.push({
image: attachment,
});
});
if (text.length) {
messagesToSend.push({
text,
});
}
if (messagesToSend.length === 0) {
return;
}
setAttachments([]);
setSheetVisible(false);
setMessagesData([...messagesData, ...messagesToSend]);
setMessageText('');
// Focus area
if (text.length) messagebar.current.focus();
// Mock response
if (responseInProgress.current) return;
responseInProgress.current = true;
setTimeout(() => {
const answer = answers[Math.floor(Math.random() * answers.length)];
const person = people[Math.floor(Math.random() * people.length)];
setTypingMessage({
name: person.name,
avatar: person.avatar,
});
setTimeout(() => {
setTypingMessage(null);
setMessagesData([
...messagesData,
...messagesToSend,
{
text: answer,
type: 'received',
name: person.name,
avatar: person.avatar,
},
]);
responseInProgress.current = false;
}, 4000);
}, 1000);
};
return (
<Page>
<Navbar title="Messages"></Navbar>
<Messagebar
placeholder={placeholder()}
attachmentsVisible={attachmentsVisible()}
sheetVisible={sheetVisible}
value={messageText}
onInput={(e) => setMessageText(e.target.value)}
>
<Link
iconIos="f7:camera_fill"
iconMd="material:camera_alt"
slot="inner-start"
onClick={() => {
setSheetVisible(!sheetVisible);
}}
/>
<Link
iconIos="f7:arrow_up_circle_fill"
iconMd="material:send"
slot="inner-end"
onClick={sendMessage}
/>
<MessagebarAttachments>
{attachments.map((image, index) => (
<MessagebarAttachment
key={index}
image={image}
onAttachmentDelete={() => deleteAttachment(image)}
/>
))}
</MessagebarAttachments>
<MessagebarSheet>
{images.map((image, index) => (
<MessagebarSheetImage
key={index}
image={image}
checked={attachments.indexOf(image) >= 0}
onChange={handleAttachment}
/>
))}
</MessagebarSheet>
</Messagebar>
<Messages>
<MessagesTitle>
<b>Sunday, Feb 9,</b> 12:58
</MessagesTitle>
{messagesData.map((message, index) => (
<Message
key={index}
type={message.type}
image={message.image}
name={message.name}
avatar={message.avatar}
first={isFirstMessage(message, index)}
last={isLastMessage(message, index)}
tail={isTailMessage(message, index)}
>
{message.text && (
<span slot="text" dangerouslySetInnerHTML={{ __html: message.text }} />
)}
</Message>
))}
{typingMessage && (
<Message
type="received"
typing={true}
first={true}
last={true}
tail={true}
header={`${typingMessage.name} is typing`}
avatar={typingMessage.avatar}
/>
)}
</Messages>
</Page>
);
};