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:

Tabs

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.

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

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.