ListSubheader API

The API documentation of the ListSubheader React component. Learn more about the props and the CSS customization points.

Import

import ListSubheader from '@material-ui/core/ListSubheader';
// or
import { ListSubheader } from '@material-ui/core';

You can learn more about the difference by reading this guide.

Component name

The MuiListSubheader name can be used for providing default props or style overrides at the theme level.

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.
color	'default' | 'inherit' | 'primary'	'default'	The color of the component. It supports those theme colors that make sense for this component.
component	elementType	'li'	The component used for the root node. Either a string to use a HTML element or a component.
disableGutters	bool	false	If true, the List Subheader will not have gutters.
disableSticky	bool	false	If true, the List Subheader will not stick to the top during scroll.
inset	bool	false	If 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).

CSS

Rule name	Global class	Description
root	.MuiListSubheader-root	Styles applied to the root element.
colorPrimary	.MuiListSubheader-colorPrimary	Styles applied to the root element if color="primary".
colorInherit	.MuiListSubheader-colorInherit	Styles applied to the root element if color="inherit".
gutters	.MuiListSubheader-gutters	Styles applied to the inner component element unless disableGutters={true}.
inset	.MuiListSubheader-inset	Styles applied to the root element if inset={true}.
sticky	.MuiListSubheader-sticky	Styles applied to the root element unless disableSticky={true}.

You can override the style of the component thanks to one of these customization points:

• With a rule name of the classes object prop.
• With a global class name.
• With a theme and an overrides property.

If that's not sufficient, you can check the implementation of the component for more detail.

Demos

• Lists