Skip to content
Edit this page

TabList API

API reference docs for the React TabList 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 TabList from '@mui/lab/TabList';
// or
import { TabList } from '@mui/lab';
You can learn about the difference by reading this guide on minimizing bundle size.

Props

Props of the Tabs component are also available.

NameTypeDescription
childrennode
A list of <Tab /> elements.

The ref is forwarded to the root element.

Inheritance

While not explicitly documented above, the props of the Tabs component are also available on TabList. You can take advantage of this to target nested components.

CSS

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

Rule nameGlobal classDescription
root.MuiTabList-rootStyles applied to the root element.
vertical.MuiTabList-verticalStyles applied to the root element if orientation="vertical".
flexContainer.MuiTabList-flexContainerStyles applied to the flex container element.
flexContainerVertical.MuiTabList-flexContainerVerticalStyles applied to the flex container element if orientation="vertical".
centered.MuiTabList-centeredStyles applied to the flex container element if centered={true} & !variant="scrollable".
scroller.MuiTabList-scrollerStyles applied to the tablist element.
fixed.MuiTabList-fixedStyles applied to the tablist element if !variant="scrollable".
scrollableX.MuiTabList-scrollableXStyles applied to the tablist element if variant="scrollable" and orientation="horizontal".
scrollableY.MuiTabList-scrollableYStyles applied to the tablist element if variant="scrollable" and orientation="vertical".
hideScrollbar.MuiTabList-hideScrollbarStyles applied to the tablist element if variant="scrollable" and visibleScrollbar={false}.
scrollButtons.MuiTabList-scrollButtonsStyles applied to the ScrollButtonComponent component.
scrollButtonsHideMobile.MuiTabList-scrollButtonsHideMobileStyles applied to the ScrollButtonComponent component if allowScrollButtonsMobile={true}.
indicator.MuiTabList-indicatorStyles applied to the TabIndicator component.

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