BottomNavigation API

API reference docs for the React BottomNavigation component. Learn about the props, CSS, and other APIs of this exported module.

Component demos

For examples and details on the usage of this React component, visit the component demo pages:

import BottomNavigation from '@mui/material/BottomNavigation';
// or
import { BottomNavigation } from '@mui/material';

Props of the native component are also available.

children

The content of the component.

Type:node

classes

Override or extend the styles applied to the component.

See CSS API below for more details.

Type:object

component

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

Type:elementType

onChange

Callback fired when the value changes.

Type:func

Signature:

function(event: React.SyntheticEvent, value: any) => void

event The event source of the callback. Warning: This is a generic event not a change event.
value We default to the index of the child.

showLabels

If true, all BottomNavigationActions will show their labels. By default, only the selected BottomNavigationAction will show its label.

Type:bool

Default:false

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

The value of the currently selected BottomNavigationAction.

Type:any

The ref is forwarded to the root element.

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

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

.MuiBottomNavigation-root

Styles applied to the root element.

Rule name:root

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.