Skip to content

BottomNavigation API

API documentation for the React BottomNavigation component. Learn about the available props, and the CSS API.

Import

import BottomNavigation from '@material-ui/core/BottomNavigation';
// or
import { BottomNavigation } from '@material-ui/core';
You can learn about the difference by reading this guide on minimizing bundle size.

Component name

The name MuiBottomNavigation can be used when providing default props or style overrides in the theme.

Props

NameTypeDefaultDescription
childrennodeThe content of the component.
classesobjectOverride or extend the styles applied to the component. See CSS API below for more details.
componentelementTypeThe component used for the root node. Either a string to use a HTML element or a component.
onChangefuncCallback fired when the value changes.

Signature:
function(event: object, 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.
showLabelsboolfalseIf true, all BottomNavigationActions will show their labels. By default, only the selected BottomNavigationAction will show its label.
sxobjectThe system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.
valueanyThe 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 nameGlobal classDescription
root.MuiBottomNavigation-rootStyles applied to the root element.

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

Demos