Skip to content

Tab API

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

Props

Props of the native component are also available.

NameTypeDefaultDescription
actionfunc
| { current?: { focusVisible: func } }

A ref for imperative actions. It currently only supports focusVisible() action.

color'danger'
| 'neutral'
| 'primary'
| 'success'
| 'warning'
| string		'neutral'

The color of the component. It supports those theme colors that make sense for this component.

To learn how to add your own colors, check out Themed components—Extend colors.

componentelementType

The component used for the root node. Either a string to use a HTML element or a component.

disabledboolfalse

If true, the component is disabled.

disableIndicatorboolfalse

If true, the pseudo element indicator is hidden.

indicatorInsetboolfalse

If true, the indicator stay within the padding based on the Tabs orientation.

indicatorPlacement'bottom'
| 'left'
| 'right'
| 'top'		row ? 'bottom' : 'right'

The indicator's position when the Tab is selected.

onChangefunc

Callback invoked when new value is being set.

orientation'horizontal'
| 'vertical'		'horizontal'

The content direction flow.

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

You can provide your own value. Otherwise, it falls back to the child position index.

variant'outlined'
| 'plain'
| 'soft'
| 'solid'
| string		'plain'

The global variant to use.

To learn how to add your own variants, check out Themed components—Extend variants.

The ref is forwarded to the root element.

Theme default props

You can use JoyTab 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.

Slot nameClass nameDefaultDescription
root.MuiTab-root'button'The component that renders the root.

CSS classes

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

Rule nameDescription
.Mui-disabledClass name applied to the root element if disabled={true}.
.Mui-focusVisibleClass name applied to the root element when its focus is visible.
.Mui-selectedClass name applied to the root element when it is selected.
.MuiTab-colorContextClass name applied to the root element when color inversion is triggered.
.MuiTab-colorDangerClass name applied to the root element if color="danger".
.MuiTab-colorNeutralClass name applied to the root element if color="neutral".
.MuiTab-colorPrimaryClass name applied to the root element if color="primary".
.MuiTab-colorSuccessClass name applied to the root element if color="success".
.MuiTab-colorWarningClass name applied to the root element if color="warning".
.MuiTab-horizontalClass name applied to the root element if orientation="horizontal".
.MuiTab-variantOutlinedClass name applied to the root element if variant="outlined".
.MuiTab-variantPlainClass name applied to the root element if variant="plain".
.MuiTab-variantSoftClass name applied to the root element if variant="soft".
.MuiTab-variantSolidClass name applied to the root element if variant="solid".
.MuiTab-verticalClass name applied to the root element if orientation="vertical".