ListSubheader API

API reference docs for the React ListSubheader component. Learn about the props, CSS, and other APIs of this exported module.

Demos

For examples and details on the usage of this React component, visit the component demo pages:

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

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

Props of the native component are also available.

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		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.
sx	Array<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.

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 using one of these customization options:

With a global class name.
With a rule name as part of the component's styleOverrides property in a custom theme.