ListSubheader

ListSubheader

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

import ListSubheader from '@material-ui/core/ListSubheader';

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 enum: 'default' |
 'primary' |
 'inherit'
'default' The color of the component. It supports those theme colors that make sense for this component.
component union: string |
 func |
 object
'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.

Any other properties supplied will be spread to the root element (native element).

CSS API

You can override all the class names injected by Material-UI thanks to the classes property. This property accepts the following keys:

Name Description
root Styles applied to the root element.
colorPrimary Styles applied to the root element if color="primary".
colorInherit Styles applied to the root element if color="inherit".
gutters Styles applied to the inner component element if disableGutters={false}.
inset Styles applied to the root element if inset={true}.
sticky Styles applied to the root element if disableSticky={false}.

Have a look at overriding with classes section and the implementation of the component for more detail.

If using the overrides key of the theme as documented here, you need to use the following style sheet name: MuiListSubheader.

Demos