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.

Demos

Import

import ListSubheader from '@mui/material/ListSubheader';
// or
import { ListSubheader } from '@mui/material';

Learn about the difference by reading this guide on minimizing bundle size.

Props

Props of the native component are also available.

NameTypeDefaultDescription
childrennode-

The content of the component.

classesobject-

Override or extend the styles applied to the component.

See CSS classes 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.

componentelementType-

The component used for the root node. Either a string to use a HTML element or a component.

disableGuttersboolfalse

If true, the List Subheader will not have gutters.

disableStickyboolfalse

If true, the List Subheader will not stick to the top during scroll.

insetboolfalse

If true, the List Subheader is indented.

sxArray<func
| 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.

CSS classes

These class names are useful for styling with CSS. They are applied to the component's slots when specific states are triggered.

Class nameRule nameDescription
.MuiListSubheader-colorInheritcolorInheritStyles applied to the root element if color="inherit".
.MuiListSubheader-colorPrimarycolorPrimaryStyles applied to the root element if color="primary".
.MuiListSubheader-guttersguttersStyles applied to the inner component element unless disableGutters={true}.
.MuiListSubheader-insetinsetStyles applied to the root element if inset={true}.
.MuiListSubheader-rootrootStyles applied to the root element.
.MuiListSubheader-stickystickyStyles applied to the root element unless disableSticky={true}.

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

Source code

If you did not find the information in this page, consider having a look at the implementation of the component for more detail.