UNPKG

materialuiupgraded

Version:

Material-UI's workspace package

material-ui.com

mui-org/material-ui

60 lines (41 loc) • 3.49 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
--- filename: /packages/material-ui/src/ListItemText/ListItemText.js title: ListItemText API --- <!--- This documentation is automatically generated, do not try to edit it. --> # ListItemText <p class="description">The API documentation of the ListItemText React component. Learn more about the properties and the CSS customization points.</p> ```js import ListItemText from '@material-ui/core/ListItemText'; ``` ## Props | Name | Type | Default | Description | |:-----|:-----|:--------|:------------| | <span class="prop-name">children</span> | <span class="prop-type">node |   | Alias for the `primary` property. | | <span class="prop-name">classes</span> | <span class="prop-type">object |   | Override or extend the styles applied to the component. See [CSS API](#css-api) below for more details. | | <span class="prop-name">disableTypography</span> | <span class="prop-type">bool | <span class="prop-default">false</span> | 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. | | <span class="prop-name">inset</span> | <span class="prop-type">bool | <span class="prop-default">false</span> | If `true`, the children will be indented. This should be used if there is no left avatar or left icon. | | <span class="prop-name">primary</span> | <span class="prop-type">node |   | The main content element. | | <span class="prop-name">primaryTypographyProps</span> | <span class="prop-type">object |   | These props will be forwarded to the primary typography component (as long as disableTypography is not `true`). | | <span class="prop-name">secondary</span> | <span class="prop-type">node |   | The secondary content element. | | <span class="prop-name">secondaryTypographyProps</span> | <span class="prop-type">object |   | These props will be forwarded to the secondary typography component (as long as disableTypography is not `true`). | Any other properties supplied will be spread to the root element (native element). ## CSS API You can override all the class names injected by Material-UI thanks to the `classes` property. This property accepts the following keys: | Name | Description | |:-----|:------------| | <span class="prop-name">root</span> | Styles applied to the root element. | <span class="prop-name">inset</span> | Styles applied to the root element if `inset={true}`. | <span class="prop-name">dense</span> | Styles applied to the root element if `context.dense` is `true`. | <span class="prop-name">primary</span> | Styles applied to the primary `Typography` component. | <span class="prop-name">secondary</span> | Styles applied to the secondary `Typography` component. | <span class="prop-name">textDense</span> | Styles applied to the `Typography` components if `context.dense` is `true`. Have a look at [overriding with classes](/customization/overrides/#overriding-with-classes) section and the [implementation of the component](https://github.com/mui-org/material-ui/tree/master/packages/material-ui/src/ListItemText/ListItemText.js) for more detail. If using the `overrides` key of the theme as documented [here](/customization/themes/#customizing-all-instances-of-a-component-type), you need to use the following style sheet name: `MuiListItemText`. ## Demos - [Lists](/demos/lists/)