ListItemText API
API reference docs for the React ListItemText component. Learn about the props, CSS, and other APIs of this exported module.
Demos
Import
import ListItemText from '@mui/material/ListItemText';
// or
import { ListItemText } from '@mui/material';
Learn about the difference by reading this guide on minimizing bundle size.
Props of the native component are also available.
Name | Type | Default | Description |
---|---|---|---|
children | node | - | Alias for the |
classes | object | - | Override or extend the styles applied to the component. See CSS classes API below for more details. |
disableTypography | bool | false | If |
inset | bool | false | If |
primary | node | - | The main content element. |
primaryTypographyProps | object | - | These props will be forwarded to the primary typography component (as long as disableTypography is not |
secondary | node | - | The secondary content element. |
secondaryTypographyProps | object | - | These props will be forwarded to the secondary typography component (as long as disableTypography is not |
slotProps | { primary?: func | object, secondary?: func | object } | {} | The props used for each slot inside. |
slots | { primary?: elementType, secondary?: elementType } | {} | The components used for each slot inside. |
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.Theme default props
You can use MuiListItemText
to change the default props of this component with the theme.
Slot name | Class name | Default component | Description |
---|---|---|---|
primary | .MuiListItemText-primary | Typography | The component that renders the primary slot. |
secondary | .MuiListItemText-secondary | Typography | The component that renders the secondary slot. |
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 |
---|---|---|
.MuiListItemText-dense | dense | Styles applied to the Typography component if dense. |
.MuiListItemText-inset | inset | Styles applied to the root element if inset={true} . |
.MuiListItemText-multiline | multiline | Styles applied to the Typography component if primary and secondary are set. |
.MuiListItemText-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.
Source code
If you did not find the information in this page, consider having a look at the implementation of the component for more detail.