ChatScrollToBottomAffordance API
API reference docs for the React ChatScrollToBottomAffordance component. Learn about the props, CSS, and other APIs of this exported module.
Demos
Import
import { ChatScrollToBottomAffordance } from '@mui/x-chat/ChatIndicators';
// or
import { ChatScrollToBottomAffordance } 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 |
|---|---|---|---|
| classes | object | - | Override or extend the styles applied to the component. See CSS classes API below for more details. |
| scrollBehavior | 'auto' | 'instant' | 'smooth' | - | The scroll behavior used when the button scrolls to the bottom. |
| slotProps | object | {} | The props used for each component slot. |
| slots | object | {} | Overridable component slots. See Slots API below for more details. |
| 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 | .MuiChatScrollToBottomAffordance-root | 'button'; a styled IconButton in `ChatScrollToBottomAffordance` | The component that renders the root. |
| badge | 'span' | The component that renders the badge. | |
| icon | A text label; an arrow icon in `ChatScrollToBottomAffordance`. | The component that renders the icon. |
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.