List
The API documentation of the List React component.
Props
| Name | Type | Default | Description |
|---|---|---|---|
| children | node | The content of the component. | |
| classes | object | Override or extend the styles applied to the component. See CSS API below for more details. | |
| component | union: string | func | object |
'ul' | The component used for the root node. Either a string to use a DOM element or a component. |
| dense | bool | false | If true, compact vertical padding designed for keyboard and mouse input will be used for the list and list items. The property is available to descendant components as the dense context. |
| disablePadding | bool | false | If true, vertical padding will be removed from the list. |
| subheader | node | The content of the subheader, normally ListSubheader. |
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 |
|---|---|
| root | Styles applied to the root element. |
| padding | Styles applied to the root element if disablePadding={false}. |
| dense | Styles applied to the root element if dense={true} & disablePadding={false}. |
| subheader | Styles applied to the root element if a subheader is provided. |
Have a look at overriding with classes section and the implementation of the component for more detail.
If using the overrides key of the theme as documented
here,
you need to use the following style sheet name: MuiList.