Skip to content

TabPanel API

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

Props

Props of the native component are also available.

NameTypeDefaultDescription
childrennode
The content of the component.
componentelementType
The component used for the root node. Either a string to use a HTML element or a component.
size'sm'
| 'md'
| 'lg'
| string
The size of the component. To learn how to add custom sizes to the component, check out Themed components—Extend sizes.
slotProps{ root?: func
| object }
{}
The props used for each slot inside.
slots{ root?: elementType }{}
The components used for each slot inside. See Slots API below for more details.
sxArray<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.
valuenumber
| string
0
The value of the TabPanel. It will be shown when the Tab with the corresponding value is selected.

The ref is forwarded to the root element.

Theme default props

You can use JoyTabPanel to change the default props of this component with the theme.

Slots

To learn how to customize the slot, check out the Overriding component structure guide.

NameDefault classDefault HTML tagDescription
root.MuiTabPanel-root'div'The component that renders the root.

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

CSS classes

These class names are useful for styling with CSS. They are applied to the root slot when specific states are triggered.

Global classDescription
.MuiTabPanel-hiddenClassname applied to the root element if the tab is not active.
.MuiTabPanel-horizontalClass name applied to the root element if orientation="horizontal".
.MuiTabPanel-sizeLgClassname applied to the root element if size="lg".
.MuiTabPanel-sizeMdClassname applied to the root element if size="md".
.MuiTabPanel-sizeSmClassname applied to the root element if size="sm".
.MuiTabPanel-verticalClass name applied to the root element if orientation="vertical".