Skip to content

BottomNavigationAction API

API documentation for the React BottomNavigationAction component. Learn about the available props, and the CSS API.

Import

import BottomNavigationAction from '@material-ui/core/BottomNavigationAction';
// or
import { BottomNavigationAction } from '@material-ui/core';
You can learn about the difference by reading this guide on minimizing bundle size.

Component name

The name MuiBottomNavigationAction can be used when providing default props or style overrides in the theme.

Props

NameTypeDefaultDescription
childrenunsupportedPropThis prop isn't supported. Use the component prop if you need to change the children structure.
classesobjectOverride or extend the styles applied to the component. See CSS API below for more details.
iconnodeThe icon to display.
labelnodeThe label element.
showLabelboolfalseIf true, the BottomNavigationAction will show its label. By default, only the selected BottomNavigationAction inside BottomNavigation will show its label.
The prop defaults to the value (false) inherited from the parent BottomNavigation component.
valueanyYou can provide your own value. Otherwise, we fallback to the child position index.

The ref is forwarded to the root element.
Any other props supplied will be provided to the root element (ButtonBase).

Inheritance

While not explicitly documented above, the props of the ButtonBase component are also available on BottomNavigationAction. You can take advantage of this to target nested components.

CSS

Rule nameGlobal classDescription
root.MuiBottomNavigationAction-rootStyles applied to the root element.
selected.Mui-selectedPseudo-class applied to the root element if selected.
iconOnly.MuiBottomNavigationAction-iconOnlyPseudo-class applied to the root element if showLabel={false} and not selected.
wrapper.MuiBottomNavigationAction-wrapperStyles applied to the span element that wraps the icon and label.
label.MuiBottomNavigationAction-labelStyles applied to the label's span element.

You can override the style of the component using one of these customization options: If that isn't sufficient, you can check the implementation of the component for more detail.

Demos