Skip to content

TabScrollButton API

API documentation for the React TabScrollButton component. Learn about the available props and the CSS API.

Import

import TabScrollButton from '@mui/material/TabScrollButton';
// or
import { TabScrollButton } from '@mui/material';
You can learn about the difference by reading this guide on minimizing bundle size.

Component name

The name MuiTabScrollButton can be used when providing default props or style overrides in the theme.

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 API below for more details.
disabledboolfalse
If true, the component is disabled.
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.

CSS

Rule nameGlobal classDescription
root.MuiTabScrollButton-rootStyles applied to the root element.
vertical.MuiTabScrollButton-verticalStyles applied to the root element if orientation="vertical".
disabled.Mui-disabledState class applied to the root element if disabled={true}.

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

Demos