Skip to content
Edit this page

BottomNavigation API

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

Props

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

The value of the currently selected BottomNavigationAction.

Type:

any
The ref is forwarded to the root element.

Theme default props

You can use MuiBottomNavigation 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.


.MuiBottomNavigation-rootroot

Styles applied to the root element.

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