ConversationList
组件主要负责会话列表功能,它包含了 Header 部分和 List 部分,具有搜索会话、创建会话、会话置顶、会话删除等功能。会话列表 | 会话操作 | 会话搜索 | 创建会话 |
| | | |
ConversationList
组件没有任何必须属性,您可以通过以下代码使用 ConversationList
。import { UIKitProvider, ConversationList } from '@tencentcloud/chat-uikit-react';const App = () => {return (<UIKitProvider><ConversationList /></UIKitProvider>);};
参数名 | 类型 | 默认值 | 说明 |
enableSearch | Boolean | true | 控制会话搜索功能是否显示。 |
enableCreate | Boolean | true | 控制创建会话功能是否显示。 |
enableActions | Boolean | true | 控制会话操作功能是否显示。 |
actionsConfig | - | 用于自定义会话操作配置。 | |
Header | ReactElement | Header | 自定义 Header 组件。 |
List | ReactElement | List | 自定义会话列表组件。 |
Preview | ReactElement | 自定义会话预览组件。 | |
ConversationCreate | ReactElement | ConversationCreate | 自定义创建会话组件。 |
ConversationSearch | ReactElement | 自定义会话搜索组件。 | |
ConversationActions | ReactElement | 自定义会话操作组件。 | |
Avatar | ReactElement | Avatar | 自定义头像组件。 |
PlaceholderEmptyList | ReactNode | <PlaceHolder type={PlaceHolderTypes.NO_CONVERSATIONS} /> | 自定义会话列表为空时的占位元素。 |
PlaceholderLoading | ReactNode | <PlaceHolder type={PlaceHolderTypes.LOADING} /> | 自定义会话列表加载中的占位元素。 |
PlaceholderLoadError | ReactNode | <PlaceHolder type={PlaceHolderTypes.WRONG} /> | 自定义会话列表加载错误时的占位元素。 |
filter | - | 用于筛选会话列表的函数。 | |
sort | - | 用于排序会话列表的函数。 | |
onConversationSelect | - | 点击会话后的回调函数,参数为所点击的会话对象。 | |
onBeforeCreateConversation | (params: CreateParams) => CreateParams; | - | 创建会话前执行的自定义操作,参数为创建会话所需的参数。 |
onConversationCreate | - | 会话创建后的回调函数,参数为创建的会话对象。 | |
className | String | - | 指定根元素类的 CSS 自定义名称。 |
style | React.CSSProperties | - | 指定根元素样式的自定义样式。 |
ConversationList
为用户自定义提供了丰富且多维度的 Props 接口,允许用户自定义功能、UI、模块等。ConversationList
组件提供了多个可替换的子组件,允许用户自定义 Header
, List
, ConversationPreview
, ConversationCreate
, ConversationSearch
, ConversationActions
, Avatar
, Placeholder
等。同时,用户还可以利用默认子组件进行二次开发定制。enableSearch
, enableCreate
和 enableActions
参数,你可以灵活地控制 ConversationList
中的搜索会话、创建会话和会话操作功能的显示。<ConversationList enableSearch={false} />
<ConversationList enableCreate={false} />
<ConversationList enableActions={false} />
enableSearch={false} | enableCreate={false} | enableActions={false} |
| | |
filterConversation
和 sortConversation
属性,可以让你对会话列表数据进行筛选和排序。filterConversation
属性传递一个筛选函数。这个函数接收一个 IConversationModel 数组作为参数,然后应该返回一个新数组,只包含符合你筛选条件的会话。filterConversation
属性来只显示“包含未读消息”的会话的例子:<ConversationListfilter={(conversationList: IConversationModel[]) =>conversationList.filter(conversation => conversation.unreadCount > 0)}/>
sortConversation
属性传递一个排序函数。这个函数接收一个 IConversationModel 数组作为参数,然后应该返回一个新数组,按照你的排序标准对会话进行排序。sortConversation
属性来按照“最新消息时间倒序”排序会话列表的例子:<ConversationListsort={(conversationList: IConversationModel[]) =>conversationList.sort((a, b) => (+(b?.lastMessage?.lastTime || 0)) - (+(a?.lastMessage?.lastTime || 0)),)}/>
filter
和 sort
属性,你可以根据你的需求有效地筛选和排序会话列表数据。<ConversationListactionsConfig={{enablePin: false,onConversationDelete: (conversation: IConversationModel) => { console.log('Delete conversation success'); },customConversationActions: {'custom-actions-1': {label: 'custom-actions',onClick: (conversation: IConversationModel) => { console.log(conversation); },},},}}/>
enablePin: false | enableDelete: false | enableMute: false | customConversationActions |
| | | |
PlaceholderEmptyList
、PlaceholderLoading
以及 PlaceholderLoadError
来定制不同状态下的列表展示。PlaceholderLoading
示例:<ConversationListPlaceholderEmptyList={<div>Empty List!!!</div>}/>
ConversationListHeader
负责 ConversationList Header 部分的渲染工作,作为包裹层渲染默认 ConversationSearch
与 ConversationCreate
。您可以通过传入 left、right 等属性进行自定义,同时,您也可以自定义整个组件。参数名 | 类型 | 默认值 | 说明 |
children | ReactNode | - | 自定义会话列表头部中心组件。 在 <ConversationList> 中使用时,会默认传入 <ConversationSearch> 和 <ConversationCreate> 。 |
left | ReactElement | - | 自定义会话列表头部左侧组件。 |
right | ReactElement | - | 自定义会话列表头部右侧组件。 |
className | String | - | 指定根元素类的 CSS 自定义名称。 |
style | React.CSSProperties | - | 指定根元素样式的自定义样式。 |
import { ConversationList, ConversationListHeader, Icon, IconTypes, IConversationListHeaderProps } from '@tencentcloud/chat-uikit-react';const CustomConversationListHeader = (props: IConversationListHeaderProps) => {const CustomIcon = <Icon type={IconTypes.ADD} onClick={() => { console.log('click'); }}></Icon>;return (<ConversationListHeader {...props} right={CustomIcon} />);};<ConversationList Header={CustomConversationListHeader} />
修改前 | 修改后 |
| |
import { useState } from 'react';import TUIChatEngine, { IConversationModel } from '@tencentcloud/chat-uikit-engine';import { ConversationList, IConversationListHeaderProps, UIKitProvider } from '@tencentcloud/chat-uikit-react';const App = () => {const [currentFilter, setCurrentFilter] = useState<string>('all');const conversationGroupFilter: Record<string, (conversationList: IConversationModel[]) => IConversationModel[]> = {all: (conversationList: IConversationModel[]) => conversationList,unread: (conversationList: IConversationModel[]) => conversationList?.filter((item: IConversationModel) => item.unreadCount > 0),c2c: (conversationList: IConversationModel[]) => conversationList?.filter((item: IConversationModel) => item.type === TUIChatEngine.TYPES.CONV_C2C),group: (conversationList: IConversationModel[]) => conversationList?.filter((item: IConversationModel) => item.type === TUIChatEngine.TYPES.CONV_GROUP),};const CustomConversationListHeader = (props: IConversationListHeaderProps) => {return (<div className="conversation-group-wrapper"><button className={currentFilter === 'all' ? 'btn-active' : 'btn-default'} onClick={() => setCurrentFilter('all')}>All</button><button className={currentFilter === 'unread' ? 'btn-active' : 'btn-default'} onClick={() => setCurrentFilter('unread')}>Unread</button><button className={currentFilter === 'c2c' ? 'btn-active' : 'btn-default'} onClick={() => setCurrentFilter('c2c')}>C2C</button><button className={currentFilter === 'group' ? 'btn-active' : 'btn-default'} onClick={() => setCurrentFilter('group')}>Group</button></div>);};return (<UIKitProvider><ConversationListstyle={{ maxWidth: '300px', height: '600px' }}Header={CustomConversationListHeader}filter={conversationGroupFilter[currentFilter]}/></UIKitProvider>);};
.conversation-group-wrapper {display: flex;justify-content: space-around;align-items: center;margin: 10px;font-size: 14px;.btn-default{display: flex;padding: 5px 10px;border: 1px solid #b3b3b4;color: #3b3d43;background-color: transparent;border-radius: 2px;}.btn-active{display: flex;padding: 5px 10px;border: 1px solid #1c66e5;color: #1c66e5;background-color: transparent;border-radius: 2px;}}
ConversationListContent
负责 ConversationList 主列表部分的渲染工作。filteredAndSortedConversationList
。参数名 | 类型 | 默认值 | 说明 |
children | ReactNode | - | 自定义会话列表内容区域组件。 在 <ConversationList> 中使用时,会默认传入 filteredAndSortedConversationList 遍历的 <Preview> 列表。 |
empty | Boolean | false | 空会话列表标识位, 在 <ConversationList> 中使用时,会判断filteredAndSortedConversationList.length === 0 并传入。 |
loading | Boolean | false | 会话列表加载中标识位,在 <ConversationList> 中使用时,使用 useConversationList() 获取 isLoading 并传入。 |
error | Boolean | false | 会话列表加载错误标识位,在 <ConversationList> 中使用时,使用 useConversationList() 获取 isLoadError 并传入。 |
PlaceholderEmptyList | ReactNode | <PlaceHolder type={PlaceHolderTypes.NO_CONVERSATIONS} /> | 自定义会话列表为空时的占位元素。 |
PlaceholderLoading | ReactNode | <PlaceHolder type={PlaceHolderTypes.LOADING} /> | 自定义会话列表加载中的占位元素。 |
PlaceholderLoadError | ReactNode | <PlaceHolder type={PlaceHolderTypes.WRONG} /> | 自定义会话列表加载错误时的占位元素。 |
className | String | - | 指定根元素类的 CSS 自定义名称。 |
style | React.CSSProperties | - | 指定根元素样式的自定义样式。 |
List
组件不同状态 UI 效果如下,在 ConversationList
内部已处理好每种状态的触发时机。empty
、loading
、error
来控制组件状态。import { ConversationList, ConversationListContent, IConversationListContentProps } from '@tencentcloud/chat-uikit-react';const CustomConversationListContent = (props: IConversationListContentProps) => {return <ConversationListContent {...props} loading={true} />;};<ConversationList List={CustomConversationListContent} />
default | empty={true} | loading={true} | error={true} |
| | | |
<ConversationList ConversationPreview={CustomConversationPreview} />
<ConversationList ConversationActions={CustomConversationActions} />
<ConversationList ConversationSearch={CustomConversationSearch} />
<ConversationList ConversationCreate={CustomConversationCreate} />
<ConversationList Avatar={CustomAvatar} />
本页内容是否解决了您的问题?