Skip to content

🎉 v5 beta is out! Head to the v5 documentation to get started.

BottomNavigation API

The API documentation of the BottomNavigation React component. Learn more about the props and the CSS customization points.

Import

import BottomNavigation from '@material-ui/core/BottomNavigation';
// or
import { BottomNavigation } from '@material-ui/core';

You can learn more about the difference by reading this guide.

Component name

The MuiBottomNavigation name can be used for providing default props or style overrides at the theme level.

Props

Name Type Default Description
children node The content of the component.
classes object Override or extend the styles applied to the component. See CSS API below for more details.
component elementType 'div' The component used for the root node. Either a string to use a HTML element or a component.
onChange func Callback fired when the value changes.

Signature:
function(event: object, value: any) => void
event: The event source of the callback.
value: We default to the index of the child.
showLabels bool false If true, all BottomNavigationActions will show their labels. By default, only the selected BottomNavigationAction will show its label.
value any The value of the currently selected BottomNavigationAction.

The ref is forwarded to the root element.

Any other props supplied will be provided to the root element (native element).

CSS

Rule name Global class Description
root .MuiBottomNavigation-root Styles applied to the root element.

You can override the style of the component thanks to one of these customization points:

If that's not sufficient, you can check the implementation of the component for more detail.

Demos