Skip to content
Edit this page

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';
Learn about the difference by reading this guide on minimizing bundle size.

Props

Props of the native component are also available.

children

The content of the component.

Type:

node
classes

Override or extend the styles applied to the component.

Type:

object
color

The color of the component. It supports those theme colors that make sense for this component.

Type:

'default' | 'inherit' | 'primary'

Default:

'default'
component

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

Type:

elementType
disableGutters

If true, the List Subheader will not have gutters.

Type:

bool

Default:

false
disableSticky

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

Type:

bool

Default:

false
inset

If true, the List Subheader is indented.

Type:

bool

Default:

false
sx

The system prop that allows defining system overrides as well as additional CSS styles.

Type:

Array<func | object | bool> | func | object
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

The following class names are useful for styling with CSS (the state classes are marked).
To learn more, visit the component customization page.

.MuiListSubheader-rootroot

Styles applied to the root element.

.MuiListSubheader-colorPrimarycolorPrimary

Styles applied to the root element if color="primary".

.MuiListSubheader-colorInheritcolorInherit

Styles applied to the root element if color="inherit".

.MuiListSubheader-guttersgutters

Styles applied to the inner component element unless disableGutters={true}.

.MuiListSubheader-insetinset

Styles applied to the root element if inset={true}.

.MuiListSubheader-stickysticky

Styles applied to the root element unless disableSticky={true}.

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