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

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

Import

import ListSubheader from '@mui/material/ListSubheader';
// or
import { ListSubheader } from '@mui/material';
You can learn about the difference by reading this guide on minimizing bundle size.

Component name

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

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

CSS

Rule nameGlobal classDescription
root.MuiListSubheader-rootStyles applied to the root element.
colorPrimary.MuiListSubheader-colorPrimaryStyles applied to the root element if color="primary".
colorInherit.MuiListSubheader-colorInheritStyles applied to the root element if color="inherit".
gutters.MuiListSubheader-guttersStyles applied to the inner `component` element unless disableGutters={true}.
inset.MuiListSubheader-insetStyles applied to the root element if inset={true}.
sticky.MuiListSubheader-stickyStyles applied to the root element unless disableSticky={true}.

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