ListItemText API
The API documentation of the ListItemText React component. Learn more about the props and the CSS customization points.
Import
import ListItemText from '@material-ui/core/ListItemText';
// or
import { ListItemText } from '@material-ui/core';
You can learn more about the difference by reading this guide.
Component name
The MuiListItemText
name can be used for providing default props or style overrides at the theme level.
Props
Name | Type | Default | Description |
---|---|---|---|
children | node | Alias for the primary prop. |
|
classes | object | Override or extend the styles applied to the component. See CSS API below for more details. | |
disableTypography | bool | false | 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. |
inset | bool | false | If true , the children are indented. This should be used if there is no left avatar or left icon. |
primary | node | The main content element. | |
primaryTypographyProps | object | These props will be forwarded to the primary typography component (as long as disableTypography is not true ). |
|
secondary | node | The secondary content element. | |
secondaryTypographyProps | object | These 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 name | Global class | Description |
---|---|---|
root | .MuiListItemText-root | Styles applied to the root element. |
multiline | .MuiListItemText-multiline | Styles applied to the Typography components if primary and secondary are set. |
dense | .MuiListItemText-dense | Styles applied to the Typography components if dense. |
inset | .MuiListItemText-inset | Styles applied to the root element if inset={true} . |
primary | .MuiListItemText-primary | Styles applied to the primary Typography component. |
secondary | .MuiListItemText-secondary | Styles applied to the secondary Typography component. |
You can override the style of the component thanks to one of these customization points:
- With a rule name of the
classes
object prop. - With a global class name.
- With a theme and an
overrides
property.
If that's not sufficient, you can check the implementation of the component for more detail.