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/joy/ListItemButton';
// or
import { ListItemButton } from '@mui/joy';Props of the native component are also available.
A ref for imperative actions. It currently only supports focusVisible() action.
Type:func
| { current?: { focusVisible: func } }
If true, the list item is focused during the first mount. Focus will also be triggered if the value changes from false to true.
Type:bool
Default:false
The color of the component. It supports those theme colors that make sense for this component.
To learn how to add your own colors, check out Themed components—Extend colors.
Type:'danger'
| 'neutral'
| 'primary'
| 'success'
| 'warning'
| string
Default:'neutral'
The component used for the root node. Either a string to use a HTML element or a component.
Type:elementType
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.
Type:string
The components used for each slot inside.
See Slots API below for more details.
Type:{ root?: elementType }
Default:{}
The system prop that allows defining system overrides as well as additional CSS styles.
See the `sx` page for more details.
Type:Array<func
| object
| bool>
| func
| object
The global variant to use.
To learn how to add your own variants, check out Themed components—Extend variants.
Type:'outlined'
| 'plain'
| 'soft'
| 'solid'
| string
Default:'plain'
ref is forwarded to the root element.Theme default props
You can use JoyListItemButton to change the default props of this component with the theme.
To learn how to customize the slot, check out the Overriding component structure guide.
These class names are useful for styling with CSS. They are applied to the component's slots when specific states are triggered.
Class name applied to the root element if color="context".
Rule name:colorContext
Class name applied to the root element if color="danger".
Rule name:colorDanger
Class name applied to the root element if color="neutral".
Rule name:colorNeutral
Class name applied to the root element if color="primary".
Rule name:colorPrimary
Class name applied to the root element if color="success".
Rule name:colorSuccess
Class name applied to the root element if color="warning".
Rule name:colorWarning
Class name applied to the root element, if orientation="horizontal".
Rule name:horizontal
State class applied to the root element if variant="outlined".
Rule name:variantOutlined
State class applied to the root element if variant="plain".
Rule name:variantPlain
State class applied to the root element if variant="soft".
Rule name:variantSoft
State class applied to the root element if variant="solid".
Rule name:variantSolid
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.