Skip to contentSkip to content

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

Props of the native component are also available.

NameTypeDefaultDescription
classesobject-

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.

slotPropsobject{}

The props used for each component slot.

slotsobject{}

Overridable component slots.

See Slots API below for more details.

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.MuiChatScrollToBottomAffordance-rootThe component that renders the root.
badgeThe component that renders the badge.
iconThe 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.