UI Kit 包含完整聊天面板和更底层的聊天组件。这些聊天组件按页加载消息,而不是在加入时加载全部聊天历史。这能让参与者很多或聊天历史很长的会议保持响应。
当你希望由 RealtimeKit 管理聊天行为时,使用完整面板。
当你需要控制消息列表、置顶消息或输入框周围的布局时,使用更底层的组件。
使用 rtk-chat 渲染完整聊天面板。它包含公开聊天、私聊、分页消息、置顶消息、文件上传、图片上传、编辑操作、删除操作和表情输入。
<rtk-ui-provider id="rtk-ui-provider">
<rtk-chat style="height: 480px;"></rtk-chat>
</rtk-ui-provider>要设置聊天 UI 覆盖项,请在 rtk-ui-provider 或 rtk-meeting 上赋值 overrides 属性。
const provider = document.querySelector("rtk-ui-provider");
provider.overrides = {
disableEmojiPicker: true,
disablePrivateChat: true,
};disableEmojiPicker 覆盖项会隐藏表情选择器按钮。disablePrivateChat 覆盖项会隐藏私聊,即使预设允许也是如此。
要为所有参与者控制私聊,优先使用预设权限。
使用 RtkChat 渲染完整聊天面板。它包含公开聊天、私聊、分页消息、置顶消息、文件上传、图片上传、编辑操作、删除操作和表情输入。
import { RtkChat, RtkUiProvider } from "@cloudflare/realtimekit-react-ui";
function ChatPanel({ meeting }) {
return (
<RtkUiProvider
meeting={meeting}
overrides={{
disableEmojiPicker: true,
disablePrivateChat: true,
}}
>
<RtkChat style={{ height: "480px" }} />
</RtkUiProvider>
);
}disableEmojiPicker 覆盖项会隐藏表情选择器按钮。disablePrivateChat 覆盖项会隐藏私聊,即使预设允许也是如此。
要为所有参与者控制私聊,优先使用预设权限。
使用 rtk-chat 渲染完整聊天面板。它包含公开聊天、私聊、分页消息、置顶消息、文件上传、图片上传、编辑操作、删除操作和表情输入。
<rtk-ui-provider [meeting]="meeting" [overrides]="chatOverrides">
<rtk-chat style="height: 480px;"></rtk-chat>
</rtk-ui-provider>chatOverrides = {
disableEmojiPicker: true,
disablePrivateChat: true,
};disableEmojiPicker 覆盖项会隐藏表情选择器按钮。disablePrivateChat 覆盖项会隐藏私聊,即使预设允许也是如此。
要为所有参与者控制私聊,优先使用预设权限。
你可以用 RtkChat 所用的同一套 UI Kit 组件创建自己的聊天布局。把每个组件放在设计需要的位置,例如侧栏中的消息列表和页脚中的输入框,并通过你自己的状态把它们连接起来。
| 组件 | 渲染内容 |
|---|---|
RtkChatSelector |
用于在公开聊天和私聊会话之间切换的下拉菜单。会发出带所选参与者的 rtkChatSelectorChange。 |
RtkPinnedMessageSelector |
可折叠的标题,展开后显示置顶消息。 |
RtkChatMessagesUiPaginated |
消息列表。privateChatRecipient 为空时加载公开消息;传入参与者时加载该私聊会话。 |
RtkChatComposerView |
消息输入框,带文件、图片和表情按钮。 |
构建自己的布局时,由你的代码把组件连接到 meeting.chat:
RtkChatMessagesUiPaginated会从其消息菜单发出pinMessage、editMessage和deleteMessage事件,但不会自行处理它们。处理这些事件并调用匹配的meeting.chat方法。RtkChatComposerView会发出newMessage和editMessage事件。用meeting.chat发送或编辑消息。- 把
meeting.chat.maxTextLimit和meeting.chat.rateLimits传给RtkChatComposerView,以便输入框强制执行与会议相同的限制。
以下示例把这些组件垂直堆叠。按你的布局重新排列它们。
import {
RtkChatComposerView,
RtkChatMessagesUiPaginated,
RtkChatSelector,
RtkPinnedMessageSelector,
} from "@cloudflare/realtimekit-react-ui";
import { useState } from "react";
function CustomChat({ meeting }) {
const [privateChatRecipient, setPrivateChatRecipient] = useState(null);
const [editingMessage, setEditingMessage] = useState(null);
const { chatPublic, chatPrivate } = meeting.self.permissions;
const publicChat = {
canSendText: chatPublic.canSend && chatPublic.text,
canSendFiles: chatPublic.canSend && chatPublic.files,
};
const privateChat = {
canSendText: Boolean(chatPrivate?.canSend && chatPrivate?.text),
canSendFiles: Boolean(chatPrivate?.canSend && chatPrivate?.files),
};
const activeChat = privateChatRecipient ? privateChat : publicChat;
return (
<div style={{ height: "480px" }}>
<RtkChatSelector
meeting={meeting}
onRtkChatSelectorChange={(event) => {
setPrivateChatRecipient(event.detail.selectedUser ?? null);
}}
/>
<RtkPinnedMessageSelector meeting={meeting} />
<RtkChatMessagesUiPaginated
meeting={meeting}
privateChatRecipient={privateChatRecipient}
onPinMessage={(event) => {
const message = event.detail;
if (message.pinned) {
meeting.chat.unpin(message.id);
} else {
meeting.chat.pin(message.id);
}
}}
onEditMessage={(event) => {
if (event.detail.type === "text") {
setEditingMessage(event.detail);
}
}}
onDeleteMessage={(event) => {
if (editingMessage?.id === event.detail.id) {
setEditingMessage(null);
}
meeting.chat.deleteMessage(event.detail.id);
}}
/>
<RtkChatComposerView
canSendTextMessage={activeChat.canSendText}
canSendFiles={activeChat.canSendFiles}
maxLength={meeting.chat.maxTextLimit}
rateLimits={meeting.chat.rateLimits}
inputTextPlaceholder="Enter a message"
isEditing={!!editingMessage}
message={editingMessage ? editingMessage.message : ""}
storageKey={
editingMessage
? `custom-chat-edit-${editingMessage.id}`
: "custom-chat-draft"
}
onNewMessage={(event) =>
meeting.chat.sendMessage(
event.detail,
privateChatRecipient ? [privateChatRecipient.id] : [],
)
}
onEditMessage={async (event) => {
try {
await meeting.chat.editTextMessage(editingMessage.id, event.detail);
} finally {
setEditingMessage(null);
}
}}
onEditCancel={() => setEditingMessage(null)}
/>
</div>
);
}有关组件属性,请参阅 RtkChat、RtkChatSelector、RtkPinnedMessageSelector、RtkChatMessagesUiPaginated 和 RtkChatComposerView API 参考。