Skip to content

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.

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'
| 'primary'
| 'inherit'
'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 DOM 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 will be indented.

The ref is forwarded to the root element.

Any other props supplied will be provided to the root element (native element).

CSS

  • Style sheet name: MuiListSubheader.
  • Style sheet details:
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 if disableGutters={false}.
inset MuiListSubheader-inset Styles applied to the root element if inset={true}.
sticky MuiListSubheader-sticky Styles applied to the root element if disableSticky={false}.

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

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

Demos