[go: up one dir, main page]

Skip to content

ListItemText API

API reference docs for the React ListItemText component. Learn about the props, CSS, and other APIs of this exported module.

DemosImport
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

Props of the native component are also available.

NameTypeDefaultDescription
childrennode-

Alias for the primary prop.

classesobject-

Override or extend the styles applied to the component.

See CSS classes API below for more details.

disableTypographyboolfalse

If true, the children won't be wrapped by a Typography component. This can be useful to render an alternative Typography variant by wrapping the children (or primary) text, and optional secondary text with the Typography component.

insetboolfalse

If true, the children are indented. This should be used if there is no left avatar or left icon.

primarynode-

The main content element.

primaryTypographyPropsobject-

These props will be forwarded to the primary typography component (as long as disableTypography is not true).

secondarynode-

The secondary content element.

secondaryTypographyPropsobject-

These props will be forwarded to the secondary typography component (as long as disableTypography is not true).

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.

sxArray<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.

The 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.

Slots
Slot nameClass nameDefault componentDescription
primary.MuiListItemText-primaryTypographyThe component that renders the primary slot.
secondary.MuiListItemText-secondaryTypographyThe component that renders the secondary slot.
CSS classes

These class names are useful for styling with CSS. They are applied to the component's slots when specific states are triggered.

Class nameRule nameDescription
.MuiListItemText-densedenseStyles applied to the Typography component if dense.
.MuiListItemText-insetinsetStyles applied to the root element if inset={true}.
.MuiListItemText-multilinemultilineStyles applied to the Typography component if primary and secondary are set.
.MuiListItemText-rootrootStyles applied to the root element.

You can override the style of the component using one of these customization options:

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.