List API
Demos
For examples and details on the usage of this React component, visit the component demo pages:
Import
import List from '@mui/material/List';
// or
import { List } from '@mui/material';
Props
Props of the native component are also available.
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 | elementType | The component used for the root node. Either a string to use a HTML element or a component. | |
dense | bool | false | If true , compact vertical padding designed for keyboard and mouse input is used for the list and list items. The prop is available to descendant components as the dense context. |
disablePadding | bool | false | If true , vertical padding is removed from the list. |
subheader | node | The content of the subheader, normally ListSubheader . | |
sx | Array<func | object | bool> | func | object | The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details. |
The
ref
is forwarded to the root element.Theme default props
You can useMuiList
to change the default props of this component with the theme.CSS
The following class names are useful for styling with CSS (the state classes are marked).
To learn more, visit the component customization page.
Rule name | Global class | Description |
---|---|---|
root | .MuiList-root | Styles applied to the root element. |
padding | .MuiList-padding | Styles applied to the root element unless disablePadding={true} . |
dense | .MuiList-dense | Styles applied to the root element if dense. |
subheader | .MuiList-subheader | Styles applied to the root element if a subheader is provided. |
You can override the style of the component using one of these customization options:
- With a global class name.
- With a rule name as part of the component's
styleOverrides
property in a custom theme.