Skip to content

ListSubheader API

API documentation for the React ListSubheader component. Learn about the available props, and the CSS API.


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

Component name

The name MuiListSubheader can be used when providing default props or style overrides in the theme.


childrennodeThe content of the component.
classesobjectOverride or extend the styles applied to the component. See CSS API below for more details.
| 'inherit'
| 'primary'
'default'The color of the component. It supports those theme colors that make sense for this component.
componentelementTypeThe component used for the root node. Either a string to use a HTML element or a component.
disableGuttersboolfalseIf true, the List Subheader will not have gutters.
disableStickyboolfalseIf true, the List Subheader will not stick to the top during scroll.
insetboolfalseIf true, the List Subheader is indented.

The ref is forwarded to the root element.
Any other props supplied will be provided to the root element (native element).


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: If that isn't sufficient, you can check the implementation of the component for more detail.