产品动态
公告
Flutter
组件概述
ConversationList 是一个会话列表组件，主要用于展示和管理用户的聊天会话。该组件提供了完整的会话列表功能，包括会话展示、交互操作等核心能力。
会话列表 | 会话操作 |
 |  |
组件集成
ConversationList 是属于 TUIKit Flutter 的一个组件，集成 TUIKit Flutter 即可获取并使用 ConversationList，集成方法请参考文档 TUIKit Flutter 里的集成步骤。
组件构成
ConversationList 组件对外仅暴露了会话列表的初始化方法，其他逻辑均封装在 ConversationList 中。
对外方法
方法名 | 参数 | 描述 |
ConversationList | onConversationClick: (ConversationInfo conversation) {} | 设置会话点击回调。 |
| config: ConversationActionConfigProtocol | 初始化组件，设置会话操作菜单项，选填。 |
| customActions: List<ConversationCustomAction> | 初始化组件，设置自定义会话操作选项，选填。 |
基础用法
ConversationList 组件可直接初始化使用，需要传入 onConversationClick 回调。
参数名 | 类型 | 描述 |
onConversationClick | (ConversationInfo conversation) {} | 会话点击回调，当用户点击某个会话 cell 时触发。 |
示例代码如下：
Expanded(child: ConversationList(onConversationClick: (conversation) {// 这里建议导航到聊天页面},),),
自定义组件
您可以自定义会话列表的操作项。方法如下。
方式 1. 局部隐藏会话操作项
初始化 ConversationList 时传入自定义 config，设置是否展示某些菜单项：
Expanded(child: ConversationList(config: ChatConversationActionConfig(isSupportDelete: true,isSupportPin: true,isSupportClearHistory: false),onConversationClick: (conversation) {// 点击会话 cell 跳转},),),
目前支持的菜单项开关操作
操作类型 | 描述 |
isSupportDelete | 是否支持删除会话。 |
isSupportPin | 是否支持置顶会话。 |
isSupportClearHistory | 是否支持清空历史消息。 |
方式 2. 局部增加会话操作项
初始化 ConversationList 时传入
customActions，ConversationList 内部会在默认的 action 底部添加您增加的自定义选项：参数名 | 类型 | 描述 |
customActions | List<ConversationCustomAction> | 自定义会话操作，当用户点击会话操作菜单时展示。 |
示例代码如下：
Expanded(child: ConversationList(customActions: [ConversationCustomAction(title: 'Share',action: (conversation) {print('Share conversation: ${conversation.title}');})],),),
方式 3. 全局配置方式
通过
AppBuilder 进行全局配置：// 在应用启动时配置，不包含则不支持await AppBuilder.init();AppBuilder.getInstance().conversationListConfig = ConversationListConfig(conversationActionList: [AppBuilder.CONVERSATION_ACTION_DELETE,AppBuilder.CONVERSATION_ACTION_PIN,AppBuilder.CONVERSATION_ACTION_CLEAR_HISTORY],// ... 其他必须属性);// 接下来再初始化 ConversationList，所有的 ConversationList 都会遵守上面 conversationActionList 的配置Expanded(child: ConversationList(onConversationClick: (conversation) {// 这里可以导航到聊天页面},),),
注意：
局部配置的优先级大于全局配置。
自定义效果如下图所示：
会话操作（默认选项） | 会话操作（隐藏 删除 选项） | 会话操作（新增 隐藏会话 选项） |
 |  |  |
文档反馈