Tabs API
The API documentation of the Tabs React component. Learn more about the properties and the CSS customization points.
import Tabs from '@material-ui/core/Tabs';
Props
Name | Type | Default | Description |
---|---|---|---|
action | func | Callback fired when the component mounts. This is useful when you want to trigger an action programmatically. It currently only supports updateIndicator() action.Signature: function(actions: object) => void actions: This object contains all possible actions that can be triggered programmatically. |
|
centered | bool | false | If true , the tabs will be centered. This property is intended for large views. |
children | node | The content of the component. | |
classes | object | Override or extend the styles applied to the component. See CSS API below for more details. | |
component | Component | 'div' | The component used for the root node. Either a string to use a DOM element or a component. |
bool | Deprecated. Instead, use the variant="fullWidth" property.If true , the tabs will grow to use all the available space. This property is intended for small views, like on mobile. |
||
indicatorColor | enum: 'secondary' | 'primary' |
'secondary' | Determines the color of the indicator. |
onChange | func | Callback fired when the value changes. Signature: function(event: object, value: number) => void event: The event source of the callback value: We default to the index of the child |
|
bool | Deprecated. Instead, use the variant="scrollable" property.If true , it will invoke scrolling properties and allow for horizontally scrolling (or swiping) of the tab bar. |
||
ScrollButtonComponent | Component | TabScrollButton | The component used to render the scroll buttons. |
scrollButtons | enum: 'auto' | 'on' | 'off' |
'auto' | Determine behavior of scroll buttons when tabs are set to scroll auto will only present them on medium and larger viewports on will always present them off will never present them |
TabIndicatorProps | object | Properties applied to the TabIndicator element. |
|
textColor | enum: 'secondary' | 'primary' | 'inherit' |
'inherit' | Determines the color of the Tab . |
value | any | The value of the currently selected Tab . If you don't want any selected Tab , you can set this property to false . |
|
variant | enum: 'standard' | 'scrollable' | 'fullWidth' |
'standard' | Determines additional display behavior of the tabs: - scrollable will invoke scrolling properties and allow for horizontally scrolling (or swiping) of the tab bar. -fullWidth will make the tabs grow to use all the available space, which should be used for small views, like on mobile. - standard will render the default state. |
Any other properties supplied will be spread to the root element (native element).
CSS
You can override all the class names injected by Material-UI thanks to the classes
property.
This property accepts the following keys:
Name | Description |
---|---|
root | Styles applied to the root element. |
flexContainer | Styles applied to the flex container element. |
centered | Styles applied to the flex container element if centered={true} & !variant="scrollable" . |
scroller | Styles applied to the tablist element. |
fixed | Styles applied to the tablist element if !variant="scrollable" . |
scrollable | Styles applied to the tablist element if variant="scrollable" . |
scrollButtons | Styles applied to the ScrollButtonComponent component. |
scrollButtonsAuto | Styles applied to the ScrollButtonComponent component if scrollButtons="auto" . |
indicator | Styles applied to the TabIndicator component. |
Have a look at overriding with classes section and the implementation of the component for more detail.
If using the overrides
key of the theme,
you need to use the following style sheet name: MuiTabs
.