list-subheader

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

Theme default props

You can use MuiListSubheader to change the default props of this component with the theme.

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

Class name	Rule name	Description
.MuiListSubheader-colorInherit	colorInherit	Styles applied to the root element if color="inherit".
.MuiListSubheader-colorPrimary	colorPrimary	Styles applied to the root element if color="primary".
.MuiListSubheader-gutters	gutters	Styles applied to the inner component element unless disableGutters={true}.
.MuiListSubheader-inset	inset	Styles applied to the root element if inset={true}.
.MuiListSubheader-root	root	Styles applied to the root element.
.MuiListSubheader-sticky	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.

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.