Skip to content

🎉 v5 release candidate is out! Head to the v5 documentation to get started.

TabScrollButton API

The API documentation of the TabScrollButton React component. Learn more about the props and the CSS customization points.

Import

import TabScrollButton from '@material-ui/core/TabScrollButton';
// or
import { TabScrollButton } from '@material-ui/core';

You can learn more about the difference by reading this guide.

Component name

The MuiTabScrollButton name can be used for providing default props or style overrides at the theme level.

Props

Name Type Default Description
children node The content of the component.
classes object Override or extend the styles applied to the component. See CSS API below for more details.
direction* 'left'
| 'right'
Which direction should the button indicate?
disabled bool If true, the element will be disabled.
orientation* 'horizontal'
| 'vertical'
The tabs orientation (layout flow direction).

The ref is forwarded to the root element.

Any other props supplied will be provided to the root element (native element).

CSS

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

You can override the style of the component thanks to one of these customization points:

If that's not sufficient, you can check the implementation of the component for more detail.

Demos