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.
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 DOM 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 BottomNavigationAction s 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
- Style sheet name:
MuiBottomNavigation
. - Style sheet details:
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:
- With a rule name of the
classes
object prop. - With a global class name.
- With a theme and an
overrides
property.
If that's not sufficient, you can check the implementation of the component for more detail.