UNPKG

materialuiupgraded

Version:

Material-UI's workspace package

62 lines (41 loc) 3.16 kB
--- filename: /packages/material-ui/src/BottomNavigationAction/BottomNavigationAction.js title: BottomNavigationAction API --- <!--- This documentation is automatically generated, do not try to edit it. --> # BottomNavigationAction <p class="description">The API documentation of the BottomNavigationAction React component. Learn more about the properties and the CSS customization points.</p> ```js import BottomNavigationAction from '@material-ui/core/BottomNavigationAction'; ``` ## Props | Name | Type | Default | Description | |:-----|:-----|:--------|:------------| | <span class="prop-name">children</span> | <span class="prop-type">unsupportedProp |   | This property isn't supported. Use the `component` property if you need to change the children structure. | | <span class="prop-name">classes</span> | <span class="prop-type">object |   | Override or extend the styles applied to the component. See [CSS API](#css-api) below for more details. | | <span class="prop-name">icon</span> | <span class="prop-type">node |   | The icon element. | | <span class="prop-name">label</span> | <span class="prop-type">node |   | The label element. | | <span class="prop-name">showLabel</span> | <span class="prop-type">bool |   | If `true`, the `BottomNavigationAction` will show its label. By default, only the selected `BottomNavigationAction` inside `BottomNavigation` will show its label. | | <span class="prop-name">value</span> | <span class="prop-type">any |   | You can provide your own value. Otherwise, we fallback to the child position index. | Any other properties supplied will be spread to the root element ([ButtonBase](/api/button-base/)). ## CSS API You can override all the class names injected by Material-UI thanks to the `classes` property. This property accepts the following keys: | Name | Description | |:-----|:------------| | <span class="prop-name">root</span> | Styles applied to the root element. | <span class="prop-name">selected</span> | Styles applied to the root element if selected. | <span class="prop-name">iconOnly</span> | Styles applied to the root element if `showLabel={false}` and not selected. | <span class="prop-name">wrapper</span> | Styles applied to the span element that wraps the icon and label. | <span class="prop-name">label</span> | Styles applied to the label's span element. Have a look at [overriding with classes](/customization/overrides/#overriding-with-classes) section and the [implementation of the component](https://github.com/mui-org/material-ui/tree/master/packages/material-ui/src/BottomNavigationAction/BottomNavigationAction.js) for more detail. If using the `overrides` key of the theme as documented [here](/customization/themes/#customizing-all-instances-of-a-component-type), you need to use the following style sheet name: `MuiBottomNavigationAction`. ## Inheritance The properties of the [ButtonBase](/api/button-base/) component are also available. You can take advantage of this behavior to [target nested components](/guides/api/#spread). ## Demos - [Bottom Navigation](/demos/bottom-navigation/)