MessageListRoot API

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

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

Props

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.
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.

Slots

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

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.