Skip to content

TabScrollButton API

API reference docs for the React TabScrollButton component. Learn about the props, CSS, and other APIs of this exported module.

Demos

Import

import TabScrollButton from '@mui/material/TabScrollButton';
// or
import { TabScrollButton } from '@mui/material';

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

Props

Props of the native component are also available.

NameTypeDefaultDescription
direction*'left'
| 'right'		-

The direction the button should indicate.

orientation*'horizontal'
| 'vertical'		-

The component orientation (layout flow direction).

childrennode-

The content of the component.

classesobject-

Override or extend the styles applied to the component.

See CSS classes API below for more details.

disabledboolfalse

If true, the component is disabled.

slotProps{ endScrollButtonIcon?: func
| object, startScrollButtonIcon?: func
| object }		{}

The extra props for the slot components. You can override the existing props or add new ones.

slots{ EndScrollButtonIcon?: elementType, StartScrollButtonIcon?: elementType }{}

The components used for each slot inside.

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 ref is forwarded to the root element.

Theme default props

You can use MuiTabScrollButton to change the default props of this component with the theme.

CSS classes

These class names are useful for styling with CSS. They are applied to the component's slots when specific states are triggered.

Class nameRule nameDescription
.Mui-disabledState class applied to the root element if disabled={true}.
.MuiTabScrollButton-rootrootStyles applied to the root element.
.MuiTabScrollButton-verticalverticalStyles applied to the root element if orientation="vertical".

You can override the style of the component using one of these customization options: