ListItemButton API
API reference docs for the React ListItemButton component. Learn about the props, CSS, and other APIs of this exported module.
Component demos
Import
import ListItemButton from '@mui/material/ListItemButton';
// or
import { ListItemButton } from '@mui/material';
Props of the ButtonBase component are also available.
Name | Type | Default | Description |
---|---|---|---|
alignItems | 'center' | 'flex-start' | 'center' | Defines the |
autoFocus | bool | false | If |
children | node | The content of the component if a | |
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 |
disabled | bool | false | If |
disableGutters | bool | false | If |
divider | bool | false | If |
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 | |
selected | bool | false | Use to apply selected styling. |
sx | Array<func | object | bool> | func | object | The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details. |
ref
is forwarded to the root element.Inheritance
While not explicitly documented above, the props of the ButtonBase component are also available in ListItemButton. You can take advantage of this to target nested components.
Theme default props
You can use MuiListItemButton
to change the default props of this component with the theme.
These class names are useful for styling with CSS. They are applied to the component's slots when specific states are triggered.
Class name | Rule name | Description |
---|---|---|
.Mui-disabled | State class applied to the inner component element if disabled={true} . | |
.Mui-focusVisible | State class applied to the component 's focusVisibleClassName prop. | |
.Mui-selected | State class applied to the root element if selected={true} . | |
.MuiListItemButton-alignItemsFlexStart | alignItemsFlexStart | Styles applied to the component element if alignItems="flex-start" . |
.MuiListItemButton-dense | dense | Styles applied to the component element if dense. |
.MuiListItemButton-divider | divider | Styles applied to the inner component element if divider={true} . |
.MuiListItemButton-gutters | gutters | Styles applied to the inner component element unless disableGutters={true} . |
.MuiListItemButton-root | 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.