Skip to content
Edit this page

TabScrollButton API

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

Demos

For examples and details on the usage of this React component, visit the component demo pages:

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

The following class names are useful for styling with CSS (the state classes are marked).
To learn more, visit the component customization page.


.MuiTabScrollButton-rootroot

Styles applied to the root element.

.MuiTabScrollButton-verticalvertical

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

.Mui-disableddisabledSTATE

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

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