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:

Bottom Navigation

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.

Name	Type	Default	Description
children	unsupportedProp	-	This prop isn't supported. Use the `component` prop if you need to change the children structure.
classes	object	-	Override or extend the styles applied to the component. See CSS classes API below for more details.
icon	node	-	The icon to display.
label	node	-	The label element.
showLabel	bool	-	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.
slotProps	{ label?: func \| object, root?: func \| object }	{}	The props used for each slot inside.
slots	{ label?: elementType, root?: elementType }	{}	The components used for each slot inside.
sx	Array<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.
value	any	-	You can provide your own value. Otherwise, we fallback to the child position index.

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.

Slots

Slot name	Class name	Default component	Description
root	.MuiBottomNavigationAction-root	`ButtonBase`	The component that renders the root.
label	.MuiBottomNavigationAction-label	`span`	The component that renders the label.

CSS classes

These class names are useful for styling with CSS. They are applied to the component's slots when specific states are triggered.

Class name	Rule name	Description
.Mui-selected		State class applied to the root element if selected.
.MuiBottomNavigationAction-iconOnly	iconOnly	State class applied to the root element if `showLabel={false}` and not selected.

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

With a global class name.
With a rule name as part of the component's styleOverrides property in a custom theme.

Source code

If you did not find the information in this page, consider having a look at the implementation of the component for more detail.