Skip to contentSkip to content

ChatSuggestions API

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

Demos

Import

import { ChatSuggestions } from '@mui/x-chat/ChatSuggestions';
// or
import { ChatSuggestions } from '@mui/x-chat';

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

Props

Props of the native component are also available.

NameTypeDefaultDescription
alwaysVisibleboolfalse

By default, suggestions only render when the active thread has no messages (treating them as an empty-state affordance). Set to true to render the suggestions regardless of message count — e.g. as a "next prompt" row above the composer in an active conversation.

autoSubmitboolfalse

Whether to auto-submit when a suggestion is clicked.

suggestionsArray<{ label?: string, value: string }
| string>
-

Suggestion items. Strings are normalized to { value, label }. Ignored when children are provided.

The component cannot hold a ref.

CSS classes

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

Class nameRule nameDescription
.MuiChatSuggestions-itemitemStyles applied to each suggestion item.
.MuiChatSuggestions-rootrootStyles applied to the root element.

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

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.