tencent cloud

即时通信 IM

动态与公告
产品动态
公告
产品简介
产品概述
基本概念
应用场景
功能介绍
账号系统
用户资料与关系链
消息管理
群组相关
公众号系统
音视频通话 Call
使用限制
购买指南
计费概述
价格说明
购买指引
续费指引
停服说明
退费说明
开发指引
Demo 专区
开通服务
体验 Demo
快速跑通
下载中心
SDK & Demo 源码
更新日志
聊天互动(含 UI)
TUIKit 组件介绍
快速开始
全功能接入
单功能接入
AI 集成
构建基础界面
更多特性
定义外观
国际化界面语言
推送服务(Push)
服务概述
名词解释
开通服务
快速跑通
厂商通道
数据统计
排查工具
客户端 API
服务端 API
推送回调
高级功能
更新日志
错误码
常见问题
智能客服
功能概述
快速入门
集成指引
管理员操作手册
客服操作手册
更多实践
直播间搭建
AI 聊天机器人方案
超大娱乐协作社群
Discord 实现指南
游戏内集成 Chat 指南
类 WhatsApp Channel 搭建方案
发送红包
Chat 应对防火墙限制相关
无 UI 集成
快速开始
集成 SDK
初始化
登录登出
消息相关
会话相关
群组相关
社群话题
用户管理
离线推送
云端搜索
本地搜索
公众号
客户端 API
JavaScript
Android
iOS & macOS
Swift
Flutter
Electron
Unity
React Native
C 接口
C++
服务端 API
生成 UserSig
REST API
第三方回调
控制台指南
新版控制台介绍
创建并升级应用
基本配置
功能配置
账号管理
群组管理
公众号管理
回调配置
用量统计
资源包查看指南
实时监控
开发辅助工具
访问管理
高级功能
常见问题
uni-app 常见问题
购买相关问题
SDK 相关问题
账号鉴权相关问题
用户资料与关系链相关问题
消息相关问题
群组相关问题
直播群相关问题
昵称头像相关问题
协议与认证
服务等级协议
安全合规认证
IM 政策
隐私政策
数据隐私和安全协议
平滑迁移方案
平滑迁移完整版
平滑迁移简化版
错误码
联系我们

MessageList

PDF
聚焦模式
字号
最后更新时间: 2025-08-13 16:07:52

组件概述

MessageList 是一个功能强大的聊天消息列表组件,提供了完整的消息展示、交互和自定义功能。该组件支持消息聚合、已读回执、消息操作、滚动控制等核心聊天功能,同时提供了丰富的自定义选项来满足不同的业务需求。


Props 属性

字段
类型
默认值
描述
alignment
'left' | 'right' | 'two-sided'
'two-sided'
消息对齐方式。
left: 所有消息左对齐。
right: 所有消息右对齐。
two-sided: 发送消息右对齐,接收消息左对齐。
boolean
false
是否启用已读回执功能。
IMessageAction[]
undefined
自定义消息操作列表,例如复制、撤回、删除等。
number
300
消息聚合时间间隔(秒),相同发送者在此时间内的连续消息会被聚合显示。
filter
(message: IMessageModel) => boolean
undefined
消息过滤函数,用于控制哪些消息需要显示。
className
string
undefined
自定义 CSS 类名。
style
React.CSSProperties
undefined
自定义内联样式。
Message
React.ComponentType
Message
自定义消息组件。
React.ComponentType
MessageTimeDivider
自定义时间分隔线组件。

属性详解

alignment

参数类型: 'left' | 'right' | 'two-sided'
alignment 用于设置消息对齐方式,支持 leftrighttwo-sided 三种模式。默认值为 'two-sided'
two-sided: 非本人的消息位于左侧,本人的消息位于右侧
left: 所有消息位于左侧
right: 所有消息位于右侧

enableReadReceipt

参数类型: boolean
enableReadReceipt 用于设置是否开启单条消息已读回执功能,默认值为 false

messageActionList

参数类型: IMessageAction[]
messageActionList 用于设置消息操作列表,例如复制、撤回、删除等操作,默认值为完整的消息操作列表 ['copy', 'recall', 'quote', 'forward', 'delete']
interface IMessageAction {
key: 'copy' | 'recall' | 'quote' | 'forward' | 'delete' | string;
label?: string;
icon?: React.ReactNode;
onClick?: (message: IMessageModel) => void;
visible?: ((message: IMessageModel) => boolean) | boolean;
component?: React.ComponentType<{ message: IMessageModel }>;
style?: React.CSSProperties;
}
可以使用 useMessageAction 获取完整的消息操作列表,然后根据需要进行自定义。

示例1: 变更消息操作列表的顺序

假设按照 forwardcopyrecallquotedelete 的顺序显示消息操作列表。
import { Chat, MessageList, useMessageActions } from '@tencentcloud/chat-uikit-react';

const App = () => {
const actions = useMessageActions(['forward', 'copy', 'recall', 'quote', 'delete']);
return (
<Chat>
<MessageList messageActionList={actions} />
</Chat>
);
}

示例2: 仅展示部分消息操作

假设仅展示 forwardcopyrecall 三个操作。
import { Chat, MessageList, useMessageActions } from '@tencentcloud/chat-uikit-react';

const App = () => {
const actions = useMessageActions(['forward', 'copy', 'recall']);
return (
<Chat>
<MessageList messageActionList={actions} />
</Chat>
);
}


示例3: 修改已有的消息操作

下面是一个自定义撤回操作的示例:
1. 将标签修改为'撤回 ⚠️'
2. 将颜色修改为橙色
3. 只有文本消息可以撤回
4. key 需要和原操作保持一致,使用 recall
import TUIChatEngine from '@tencentcloud/chat-uikit-engine';
import { Chat, MessageList, useMessageActions } from '@tencentcloud/chat-uikit-react';

const ChatApp = () => {
const actions = useMessageActions(['copy', {
key: 'recall',
label: 'Recall ⚠️',
style: {
color: 'orange'
},
visible: (message) => message.type === TUIChatEngine.TYPES.MSG_TEXT,
}, 'quote', 'forward', 'delete']);

return (
<Chat>
<MessageList messageActionList={actions} />
</Chat>
);
}
效果如下图所示:


示例4: 新增自定义消息操作

假设需要自定义消息操作,如仅其他人发送的消息可以标记'喜欢',且插入在'撤回'操作之后。
import { useMessageAction } from '@tencentcloud/chat-uikit-react';
import { yourApi } from '@/api/yourApi';

const customActions = {
key: 'like',
label: 'Like',
icon: <span>👍</span>,
style: {
color: '#E53888',
},
visible: (message) => message.flow === 'in',
onClick: (message) => {
yourApi.likeMessage(message.ID);
}
}

function ChatApp() {
const actions = useMessageAction(['forward', 'copy', 'recall', customActions, 'quote', 'delete']);
return <MessageList messageActionList={actions} />;
}
效果如下图所示:



messageAggregationTime

参数类型: number
messageAggregationTime 用于设置消息聚合时间间隔,将相同发送者的连续消息聚合显示,默认值为 300(秒)。

filter

参数类型: (message: IMessageModel) => boolean
filter 用于设置消息过滤函数,控制哪些消息需要显示,默认值为 undefined

示例: 过滤掉机器人发送的错误消息

import { MessageList } from '@/components/MessageList';
import TUIChatEngine from '@tencentcloud/chat-uikit-engine';

const messageFilter = (message) => {
// 过滤掉发送者昵称包含 '_robot' 且内容包含 'operation-failed' 的文本消息
if (
message.nick?.includes('_robot')
&& message.type === TUIChatEngine.TYPES.MSG_TEXT
&& message.payload?.text?.includes('operation-failed')
) {
return false;
}
return true;
};

function ChatApp() {
return <MessageList filter={messageFilter} />;
}

className

参数类型: string
className 用于设置根容器自定义 CSS 类名,默认值为 undefined

style

参数类型: React.CSSProperties
style 用于设置根容器自定义内联样式,默认值为 undefined

Message

参数类型: React.ComponentType
Message 用于设置自定义消息组件,替换默认的消息渲染组件,默认值为内置的 Message 组件。

示例: 自定义 CUSTOM 消息点击跳转的消息组件

import TUIChatEngine from '@tencentcloud/chat-uikit-engine';
import { Chat, MessageList, Message } from '@tencentcloud/chat-uikit-react';

function CustomMessage(props) {
const { message } = props;

if (message.type === TUIChatEngine.TYPES.MSG_CUSTOM) {
const { businessID, ...restData } = JSON.parse(message.payload.data);
if (businessID === 'text_link') {
return (
<div>
<div>{restData.text}</div>
<a href={restData.link}>
跳转到外部网址 {restData.link}
</a>
</div>
);
}
} else {
// 其他消息类型使用默认消息组件
return <Message {...props} />;
}
}

function ChatApp() {
return (
<Chat>
<MessageList Message={CustomMessage} />
</Chat>
);
}

MessageTimeDivider

参数类型: React.ComponentType
MessageTimeDivider 用于设置自定义时间分隔线组件,默认值为内置的 MessageTimeDivider 组件。

示例: 区分工作时间的时间分隔线

import { Chat, MessageList, MessageTimeDivider } from '@tencentcloud/chat-uikit-react';

const BusinessTimeDivider = (props: React.ComponentProps<typeof MessageTimeDivider>) => {
const { prevMessage, currentMessage } = props;

if (!prevMessage || !currentMessage) return null;
// 对于即将渲染的每一条消息获取当前消息和上一消息的时间,并转换为日期对象,判断是否跨天或间隔超过4小时
const currentTime = new Date(currentMessage.time * 1000);
const prevTime = new Date(prevMessage.time * 1000);
// 跨天或间隔超过4小时才显示
const shouldShow = currentTime.toDateString() !== prevTime.toDateString() ||
(currentTime.getTime() - prevTime.getTime()) > 4 * 60 * 60 * 1000;
if (!shouldShow) return null;
// 判断工作时间 (9:00-18:00, 周一到周五)
const isWorkingTime = () => {
const hour = currentTime.getHours();
const day = currentTime.getDay();
return day >= 1 && day <= 5 && hour >= 9 && hour <= 18;
};
const timeLabel = isWorkingTime() ? '工作时间' : '非工作时间';
const timeColor = isWorkingTime() ? '#52c41a' : '#faad14';
return (
<div style={{ textAlign: 'center', margin: '16px 0' }}>
<span style={{
backgroundColor: timeColor,
color: 'white',
padding: '2px 8px',
borderRadius: '12px',
marginRight: '8px'
}}>
{timeLabel}
</span>
{currentTime.toLocaleString()}
</div>
);
};

function ChatApp() {
return (
<Chat>
<MessageList MessageTimeDivider={BusinessTimeDivider} />
</Chat>
);
}
效果图如下所示:




总结

MessageList 组件提供了完整的消息列表功能和丰富的自定义选项。通过合理配置 Props 和自定义组件,您可以创建出符合业务需求的聊天界面。建议在实际使用中根据具体场景选择合适的配置。

帮助和支持

本页内容是否解决了您的问题?

填写满意度调查问卷,共创更好文档体验。

文档反馈