ConversationListRoot API

API reference docs for the React ConversationListRoot component. Learn about the props, CSS, and other APIs of this exported module.

Demos

For examples and details on the usage of this React component, visit the component demo pages:

Import

import { ConversationListRoot } from '@mui/x-chat-headless/conversation-list';
// or
import { ConversationListRoot } from '@mui/x-chat-headless';
// or
import { ConversationListRoot } from '@mui/x-chat';

Learn about the difference by reading this guide on minimizing bundle size.

Props

Name	Type	Default	Description
slotProps	ConversationListRootSlotProps	-
slots	Partial	-	See Slots API below for more details.
variant	'compact' \| 'default'	'default'	The visual variant of the conversation list. - `'default'` – shows avatar, title, preview, timestamp, and unread badge. - `'compact'` – shows only a small unread indicator, the title, and an actions button.

The component cannot hold a ref.

Slots

Slot name	Class name	Default component	Description
item
itemActions
itemAvatar
itemContent
preview
root
scrollbar
scrollbarThumb
scroller
timestamp
title
unreadBadge
viewport

Source code

If you did not find the information in this page, consider having a look at the implementation of the component for more detail.