Skip to content

ListItemText API

API documentation for the React ListItemText component. Learn about the available props, and the CSS API.

Import

import ListItemText from '@material-ui/core/ListItemText';
// or
import { ListItemText } from '@material-ui/core';
You can learn about the difference by reading this guide on minimizing bundle size.

Component name

The name MuiListItemText can be used when providing default props or style overrides in the theme.

Props

NameTypeDefaultDescription
childrennodeAlias for the primary prop.
classesobjectOverride or extend the styles applied to the component. See CSS API below for more details.
disableTypographyboolfalseIf 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.
insetboolfalseIf true, the children are indented. This should be used if there is no left avatar or left icon.
primarynodeThe main content element.
primaryTypographyPropsobjectThese props will be forwarded to the primary typography component (as long as disableTypography is not true).
secondarynodeThe secondary content element.
secondaryTypographyPropsobjectThese props will be forwarded to the secondary typography component (as long as disableTypography is not true).

The ref is forwarded to the root element.
Any other props supplied will be provided to the root element (native element).

CSS

Rule nameGlobal classDescription
root.MuiListItemText-rootStyles applied to the root element.
multiline.MuiListItemText-multilineStyles applied to the `Typography` components if primary and secondary are set.
dense.MuiListItemText-denseStyles applied to the `Typography` components if dense.
inset.MuiListItemText-insetStyles applied to the root element if inset={true}.
primary.MuiListItemText-primaryStyles applied to the primary `Typography` component.
secondary.MuiListItemText-secondaryStyles applied to the secondary `Typography` component.

You can override the style of the component using one of these customization options: If that isn't sufficient, you can check the implementation of the component for more detail.

Demos