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 of the native component are also available.
| Name | Type | Default | Description |
|---|---|---|---|
| alwaysVisible | bool | false | By default, suggestions only render when the active thread has no messages (treating them as an empty-state affordance). Set to |
| autoSubmit | bool | false | Whether to auto-submit when a suggestion is clicked. |
| children | node | - | The suggestions to render, instead of |
| classes | object | - | Override or extend the styles applied to the component. See CSS classes API below for more details. |
| slotProps | object | {} | The props used for each component slot. |
| slots | object | {} | Overridable component slots. See Slots API below for more details. |
| suggestions | Array<{ label?: string, value: string } | string> | - | Suggestion items. Strings are normalized to |
| sx | Array<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. |
| Slot name | Class name | Default component | Description |
|---|---|---|---|
| root | .MuiChatSuggestions-root | The component that renders the root. | |
| item | .MuiChatSuggestions-item | The 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.