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';Component name
The nameMuiListItemText can be used when providing default props or style overrides in the theme.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 using one of these customization options:
- With a rule name of the
classesobject prop. - With a global class name.
- With a theme and an
styleOverridesproperty.