ListItemButton API
API documentation for the React ListItemButton component. Learn about the available props, and the CSS API.
Import
import ListItemButton from '@material-ui/core/ListItemButton';
// or
import { ListItemButton } from '@material-ui/core';Component name
The nameMuiListItemButton can be used when providing default props or style overrides in the theme.Props
Props of the ButtonBase component are also available.
| Name | Type | Default | Description |
|---|---|---|---|
| alignItems | 'center' | 'flex-start' | 'center' | Defines the align-items style property. |
| autoFocus | bool | false | If true, the list item is focused during the first mount. Focus will also be triggered if the value changes from false to true. |
| children | node | The content of the component if a ListItemSecondaryAction is used it must be the last child. | |
| 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. | |
| dense | bool | false | If true, compact vertical padding designed for keyboard and mouse input is used. The prop defaults to the value inherited from the parent List component. |
| disabled | bool | false | If true, the component is disabled. |
| disableGutters | bool | false | If true, the left and right padding is removed. |
| divider | bool | false | If true, a 1px light border is added to the bottom of the list item. |
| focusVisibleClassName | string | This prop can help identify which element has keyboard focus. The class name will be applied when the element gains the focus through keyboard interaction. It's a polyfill for the CSS :focus-visible selector. The rationale for using this feature is explained here. A polyfill can be used to apply a focus-visible class to other components if needed. | |
| selected | bool | false | Use to apply selected styling. |
| sx | object | The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details. |
The
ref is forwarded to the root element.Inheritance
While not explicitly documented above, the props of the ButtonBase component are also available on ListItemButton. You can take advantage of this to target nested components.CSS
| Rule name | Global class | Description |
|---|---|---|
| root | .MuiListItemButton-root | Styles applied to the root element. |
| focusVisible | .Mui-focusVisible | Pseudo-class applied to the `component`'s `focusVisibleClassName` prop. |
| dense | .MuiListItemButton-dense | Styles applied to the component element if dense. |
| alignItemsFlexStart | .MuiListItemButton-alignItemsFlexStart | Styles applied to the component element if alignItems="flex-start". |
| disabled | .Mui-disabled | Pseudo-class applied to the inner `component` element if disabled={true}. |
| divider | .MuiListItemButton-divider | Styles applied to the inner `component` element if divider={true}. |
| gutters | .MuiListItemButton-gutters | Styles applied to the inner `component` element unless disableGutters={true}. |
| selected | .Mui-selected | Pseudo-class applied to the root element if selected={true}. |
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
styleOverridesproperty in a custom theme.