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';
Component name
The nameMuiBottomNavigation
can be used when providing default props or style overrides in the theme.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 | 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. 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 BottomNavigationAction s will show their labels. By default, only the selected BottomNavigationAction will show its label. |
sx | 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.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 using one of these customization options:
- With a global class name.
- With a rule name as part of the component's
styleOverrides
property in a custom theme.