ListItemText API
The API documentation of the ListItemText React component. Learn more about the properties and the CSS customization points.
import ListItemText from '@material-ui/core/ListItemText';Props
| Name | Type | Default | Description |
|---|---|---|---|
| children | node | Alias for the primary property. |
|
| 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 will be 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 properties supplied will be provided to the root element (native element).
CSS
You can override all the class names injected by Material-UI thanks to the classes property.
This property accepts the following keys:
| Name | Description |
|---|---|
| root | Styles applied to the root element. |
| multiline | Styles applied to the Typography components if primary and secondary are set. |
| dense | Styles applied to the Typography components if dense. |
| inset | Styles applied to the root element if inset={true}. |
| primary | Styles applied to the primary Typography component. |
| secondary | Styles applied to the secondary Typography component. |
Have a look at the overriding styles with classes section and the implementation of the component for more detail.
If using the overrides key of the theme,
you need to use the following style sheet name: MuiListItemText.
Notes
The component is fully StrictMode compatible.