ChatSuggestions API

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

Name	Type	Default	Description
autoSubmit	bool	false	Whether to auto-submit when a suggestion is clicked.
classes	Partial	-	See CSS classes API below for more details.
slotProps	SuggestionsRootSlotProps	-
slots	Partial	-	See Slots API below for more details.
suggestions	Array<string \| { label?: string, value: string }>	-	Suggestion items. Strings are normalized to `{ value, label }`. Ignored when `children` are provided.

The component cannot hold a ref.

Slot name	Class name	Default component	Description
item	.MuiChatSuggestions-item
root	.MuiChatSuggestions-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
.MuiChatSuggestions-item	item	Styles applied to each suggestion item.
.MuiChatSuggestions-root	root	Styles applied to the root 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.