SuggestionsRoot API

API reference docs for the React SuggestionsRoot 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

import { SuggestionsRoot } from '@mui/x-chat-headless/suggestions';
// or
import { SuggestionsRoot } from '@mui/x-chat-headless';
// or
import { SuggestionsRoot } from '@mui/x-chat';

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

Props

Name	Type	Default	Description
autoSubmit	bool	false	Whether to auto-submit when a suggestion is clicked.
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.

Slots

Slot name	Class name	Default component	Description
item
root

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.