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.

childrennode-

The suggestions to render, instead of suggestions.

classesobject-

Override or extend the styles applied to the component.

See CSS classes API below for more details.

slotPropsobject{}

The props used for each component slot.

slotsobject{}

Overridable component slots.

See Slots API below for more details.

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

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

sxArray<func
| object
| bool>
| func
| object
-

The system prop that allows defining system overrides as well as additional CSS styles.

See the `sx` page for more details.

The component cannot hold a ref.

Slots

Slot nameClass nameDefault componentDescription
root.MuiChatSuggestions-rootThe component that renders the root.
item.MuiChatSuggestions-itemThe component that renders each suggestion.

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.