Skip to content

ListSubheader API

API reference docs for the React ListSubheader component. Learn about the props, CSS, and other APIs of this exported module.


For examples and details on the usage of this React component, visit the component demo pages:


import ListSubheader from '@mui/material/ListSubheader';
// or
import { ListSubheader } from '@mui/material';
You can learn about the difference by reading this guide on minimizing bundle size.


Props of the native component are also available.

The content of the component.
Override or extend the styles applied to the component. See CSS API below for more details.
| 'inherit'
| 'primary'
The color of the component. It supports those theme colors that make sense for this component.
The component used for the root node. Either a string to use a HTML element or a component.
If true, the List Subheader will not have gutters.
If true, the List Subheader will not stick to the top during scroll.
If true, the List Subheader is indented.
| 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 use MuiListSubheader to change the default props of this component with the theme.


The following class names are useful for styling with CSS (the state classes are marked).
To learn more, visit the component customization page.

Rule nameGlobal classDescription
root.MuiListSubheader-rootStyles applied to the root element.
colorPrimary.MuiListSubheader-colorPrimaryStyles applied to the root element if color="primary".
colorInherit.MuiListSubheader-colorInheritStyles applied to the root element if color="inherit".
gutters.MuiListSubheader-guttersStyles applied to the inner `component` element unless disableGutters={true}.
inset.MuiListSubheader-insetStyles applied to the root element if inset={true}.
sticky.MuiListSubheader-stickyStyles applied to the root element unless disableSticky={true}.

You can override the style of the component using one of these customization options: