Skip to content
Edit this page

BottomNavigationAction API

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

Props

Props of the ButtonBase component are also available.

children

This prop isn't supported. Use the component prop if you need to change the children structure.

Type:

unsupportedProp
classes

Override or extend the styles applied to the component.

See CSS API below for more details.

Type:

object
icon

The icon to display.

Type:

node
label

The label element.

Type:

node
showLabel

If 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.

Type:

bool
sx

The system prop that allows defining system overrides as well as additional CSS styles.

See the `sx` page for more details.

Type:

Array<func | object | bool> | func | object
value

You can provide your own value. Otherwise, we fallback to the child position index.

Type:

any
The ref is forwarded to the root element.

Inheritance

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

Theme default props

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

CSS

The following class names are useful for styling with CSS (the state classes are marked).
To learn more, visit the component customization page.


.MuiBottomNavigationAction-rootroot

Styles applied to the root element.

.Mui-selectedselectedSTATE

State class applied to the root element if selected.

.MuiBottomNavigationAction-iconOnlyiconOnly

State class applied to the root element if showLabel={false} and not selected.

.MuiBottomNavigationAction-labellabel

Styles applied to the label's span element.

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