BottomNavigation API
The API documentation of the BottomNavigation React component. Learn more about the properties and the CSS customization points.
import BottomNavigation from '@material-ui/core/BottomNavigation';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) => voidevent: 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 properties supplied will be provided to the root element (native element).
CSS
You can override all the class names injected by Material-UI thanks to the classes prop.
This prop accepts the following keys:
| Name | Description |
|---|---|
| root | Styles applied to the root element. |
Have a look at the overriding styles with classes section and the implementation of the component for more detail.
If using the overrides key of the theme,
you need to use the following style sheet name: MuiBottomNavigation.
Notes
The component is fully StrictMode compatible.