TabList API

API reference docs for the React TabList component. Learn about the props, CSS, and other APIs of this exported module.

Component 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';

Learn about the difference by reading this guide on minimizing bundle size.

Props

Props of the Tabs component are also available.

children

A list of <Tab /> elements.

Type:node

The ref is forwarded to the root element.

Inheritance

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

CSS classes

These class names are useful for styling with CSS. They are applied to the component's slots when specific states are triggered.

.MuiTabList-centered

Styles applied to the flex container element if centered={true} & !variant="scrollable".

Rule name:centered

.MuiTabList-fixed

Styles applied to the tablist element if !variant="scrollable".

Rule name:fixed

.MuiTabList-flexContainer

Styles applied to the flex container element.

Rule name:flexContainer

.MuiTabList-flexContainerVertical

Styles applied to the flex container element if orientation="vertical".

Rule name:flexContainerVertical

.MuiTabList-hideScrollbar

Styles applied to the tablist element if variant="scrollable" and visibleScrollbar={false}.

Rule name:hideScrollbar

.MuiTabList-indicator

Styles applied to the TabIndicator component.

Rule name:indicator

.MuiTabList-root

Styles applied to the root element.

Rule name:root

.MuiTabList-scrollableX

Styles applied to the tablist element if variant="scrollable" and orientation="horizontal".

Rule name:scrollableX

.MuiTabList-scrollableY

Styles applied to the tablist element if variant="scrollable" and orientation="vertical".

Rule name:scrollableY

.MuiTabList-scrollButtons

Styles applied to the ScrollButtonComponent component.

Rule name:scrollButtons

.MuiTabList-scrollButtonsHideMobile

Styles applied to the ScrollButtonComponent component if allowScrollButtonsMobile={true}.

Rule name:scrollButtonsHideMobile

.MuiTabList-scroller

Styles applied to the tablist element.

Rule name:scroller

.MuiTabList-vertical

Styles applied to the root element if orientation="vertical".

Rule name:vertical

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.