ChatComposer API

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

Name	Type	Default	Description
attachmentConfig	{ acceptedMimeTypes?: Array<string>, maxFileCount?: number, maxFileSize?: number, onAttachmentReject?: func }	-	Configuration for attachment validation constraints. When provided, file attachments are validated against these rules.
classes	Partial	-	See CSS classes API below for more details.
disabled	bool	-
features	{ attachments?: bool \| bool \| { acceptedMimeTypes?: Array<string>, maxFileCount?: number, maxFileSize?: number, onAttachmentReject?: func } }	-	Feature flags to control composer capabilities.
slotProps	ComposerRootSlotProps	-
slots	Partial	-	See Slots API below for more details.
variant	'compact' \| 'default'	'default'	The visual layout variant of the composer. - `'default'` – Stacked layout: attachment list, textarea, then toolbar below. - `'compact'` – Inline layout: start actions, textarea, end actions in a single row. When omitted, inherits from the nearest `ChatVariantProvider` (e.g. set by `ChatBox`).

The component cannot hold a ref.

Slot name	Class name	Default component	Description
root	.MuiChatComposer-root

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
.Mui-disabled		Styles applied to the root element when disabled.
.MuiChatComposer-attachButton	attachButton	Styles applied to the attach button element.
.MuiChatComposer-attachmentList	attachmentList	Styles applied to the attachment list element.
.MuiChatComposer-helperText	helperText	Styles applied to the helper text element.
.MuiChatComposer-label	label	Styles applied to the input label element.
.MuiChatComposer-root	root	Styles applied to the input root element.
.MuiChatComposer-sendButton	sendButton	Styles applied to the send button element.
.MuiChatComposer-textArea	textArea	Styles applied to the textarea element.
.MuiChatComposer-toolbar	toolbar	Styles applied to the toolbar element.
.MuiChatComposer-variantCompact	variantCompact	Styles applied to the root element when variant="compact".

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.