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';
Component name
The nameMuiTabScrollButton
can be used when providing default props or style overrides in the theme.Props
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 API below for more details. | |
disabled | bool | false | If true , the component is disabled. |
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.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 | State class applied to the root element if disabled={true} . |
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.