ChatMessageList API

API reference docs for the React ChatMessageList 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 { ChatMessageList } from '@mui/x-chat/ChatMessageList';
// or
import { ChatMessageList } from '@mui/x-chat';

Name	Type	Default	Description
renderItem*	func	-	Signature:`function(params: { id: string; index: number; }) => ReactNode`
autoScroll	bool \| bool \| { buffer?: number }	true	Controls automatic scrolling to the bottom when new messages arrive or streaming content grows, as long as the user is within `buffer` pixels of the bottom. - `true` – enable with the default buffer (150 px). - `{ buffer: number }` – enable with a custom threshold. - `false` – disable (the scroll-to-bottom affordance is still available). Scrolling when the user sends a message is always active.
classes	Partial	-	See CSS classes API below for more details.
estimatedItemSize	number	-
getItemKey	func	-	Signature:`function(id: string, index: number) => Key`
items	Array<string>	-
onReachTop	func	-	Signature:`function() => void`
overlay	node	-
slotProps	MessageListRootSlotProps	-
slots	Partial	-	See Slots API below for more details.

The component cannot hold a ref.

Slot name	Class name	Default component	Description
messageList
messageListContent
messageListOverlay
messageListScrollbar
messageListScrollbarThumb
messageListScroller

These class names are useful for styling with CSS. They are applied to the component's slots when specific states are triggered.

Class name	Rule name	Description
.MuiChatMessageList-content	content	Styles applied to the message list content element.
.MuiChatMessageList-root	root	Styles applied to the message list root element.
.MuiChatMessageList-scroller	scroller	Styles applied to the message list scroller element.

You can override the style of the component using one of these customization options:

With a global class name.
With a rule name as part of the component's styleOverrides property in a custom theme.

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