0 Tk

bottom-navigation

API reference docs for the React BottomNavigation component

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 of the native component are also available.

Name Type Default Description
children node - The content of the component.
classes object - Override or extend the styles applied to the component. See CSS classes API below for more details.
component elementType - 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: 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 bool false If true, all BottomNavigationActions will show their labels. By default, only the selected BottomNavigationAction will show its label.
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 - The value of the currently selected BottomNavigationAction.

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.

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
.MuiBottomNavigation-root root Styles applied to the root element.

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

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.