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.

Component 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.

directionRequired

The direction the button should indicate.

Type:'left'
| 'right'

orientationRequired

The component orientation (layout flow direction).

Type:'horizontal'
| 'vertical'

children

The content of the component.

Type:node

classes

Override or extend the styles applied to the component.

See CSS API below for more details.

Type:object

disabled

If true, the component is disabled.

Type:bool

Default:false

slotProps

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

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

Default:{}

slots

The components used for each slot inside.

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

Default:{}

sx

The system prop that allows defining system overrides as well as additional CSS styles.

See the `sx` page for more details.

Type:Array<func
| object
| bool>
| func
| object

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.

.Mui-disabledSTATE

State class applied to the root element if disabled={true}.

.MuiTabScrollButton-root

Styles applied to the root element.

Rule name:root

.MuiTabScrollButton-vertical

Styles applied to the root element if orientation="vertical".

Rule name:vertical


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