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 TabScrollButton from '@mui/material/TabScrollButton';
// or
import { TabScrollButton } from '@mui/material';

Props of the native component are also available.

Name	Type	Default	Description
direction*	'left' \| 'right'	-	The direction the button should indicate.
orientation*	'horizontal' \| 'vertical'	-	The component orientation (layout flow direction).
children	node	-	The content of the component.
classes	object	-	Override or extend the styles applied to the component. See CSS classes API below for more details.
disabled	bool	false	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.
sx	Array<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.

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

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

Class name	Rule name	Description
.Mui-disabled		State class applied to the root element if `disabled={true}`.
.MuiTabScrollButton-root	root	Styles applied to the root element.
.MuiTabScrollButton-vertical	vertical	Styles applied to the root element if `orientation="vertical"`.

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

With a global class name.
With a rule name as part of the component's styleOverrides property in a custom theme.

If you did not find the information in this page, consider having a look at the implementation of the component for more detail.