ListItem API
API reference docs for the React ListItem component. Learn about the props, CSS, and other APIs of this exported module.
Component demos
Import
import ListItem from '@mui/joy/ListItem';
// or
import { ListItem } from '@mui/joy';
Props of the native component are also available.
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
The props used for each slot inside.
Type:{ endAction?: func
| object, root?: func
| object, startAction?: func
| object }
Default:{}
The components used for each slot inside.
See Slots API below for more details.
Type:{ endAction?: elementType, root?: elementType, startAction?: 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 JoyListItem
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.
The component that renders the start action.
Global class: .MuiListItem-startAction
Default: 'div'
These class names are useful for styling with CSS. They are applied to the root slot when specific states are triggered.