Skip to content
Edit this page

Tabs API

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

Import

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

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

Component name

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

Props

Name Type Default Description
action ref Callback fired when the component mounts. This is useful when you want to trigger an action programmatically. It supports two actions: updateIndicator() and updateScrollButtons()
allowScrollButtonsMobile bool false If true, the scroll buttons aren't forced hidden on mobile. By default the scroll buttons are hidden on mobile and takes precedence over scrollButtons.
aria-label string The label for the Tabs as a string.
aria-labelledby string An id or list of ids separated by a space that label the Tabs.
centered bool false If true, the tabs will be centered. This prop is intended for large views.
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.
component elementType 'div' The component used for the root node. Either a string to use a HTML element or a component.
indicatorColor 'primary'
| 'secondary'		 'secondary' Determines the color of the indicator.
onChange func Callback fired when the value changes.

Signature:
function(event: object, value: any) => void
event: The event source of the callback. Warning: This is a generic event not a change event.
value: We default to the index of the child (number)
orientation 'horizontal'
| 'vertical'		 'horizontal' The tabs orientation (layout flow direction).
ScrollButtonComponent elementType TabScrollButton The component used to render the scroll buttons.
scrollButtons 'auto'
| false
| true		 'auto' Determine behavior of scroll buttons when tabs are set to scroll:
- auto will only present them when not all the items are visible. - true will always present them. - false will never present them.
By default the scroll buttons are hidden on mobile. This behavior can be disabled with allowScrollButtonsMobile.
selectionFollowsFocus bool If true the selected tab changes on focus. Otherwise it only changes on activation.
TabIndicatorProps object {} Props applied to the tab indicator element.
TabScrollButtonProps object Props applied to the TabScrollButton element.
textColor 'inherit'
| 'primary'
| 'secondary'		 'inherit' Determines the color of the Tab.
value any The value of the currently selected Tab. If you don't want any selected Tab, you can set this prop to false.
variant 'fullWidth'
| 'scrollable'
| 'standard'		 'standard' Determines additional display behavior of the tabs:
- scrollable will invoke scrolling properties and allow for horizontally scrolling (or swiping) of the tab bar. -fullWidth will make the tabs grow to use all the available space, which should be used for small views, like on mobile. - standard will render the default state.
visibleScrollbar bool false If true, the scrollbar will be visible. It can be useful when displaying a long vertical list of tabs.

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 .MuiTabs-root Styles applied to the root element.
vertical .MuiTabs-vertical Styles applied to the root element if orientation="vertical".
flexContainer .MuiTabs-flexContainer Styles applied to the flex container element.
flexContainerVertical .MuiTabs-flexContainerVertical Styles applied to the flex container element if orientation="vertical".
centered .MuiTabs-centered Styles applied to the flex container element if centered={true} & !variant="scrollable".
scroller .MuiTabs-scroller Styles applied to the tablist element.
fixed .MuiTabs-fixed Styles applied to the tablist element if !variant="scrollable".
scrollableX .MuiTabs-scrollableX Styles applied to the tablist element if variant="scrollable" and orientation="horizontal".
scrollableY .MuiTabs-scrollableY Styles applied to the tablist element if variant="scrollable" and orientation="vertical".
hideScrollbar .MuiTabs-hideScrollbar Styles applied to the tablist element if variant="scrollable" and visibleScrollbar={false}.
scrollButtons .MuiTabs-scrollButtons Styles applied to the ScrollButtonComponent component.
scrollButtonsHideMobile .MuiTabs-scrollButtonsHideMobile Styles applied to the ScrollButtonComponent component if allowScrollButtonsMobile={true}.
indicator .MuiTabs-indicator Styles applied to the TabIndicator component.

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