ListSubheader API
API reference docs for the React ListSubheader component. Learn about the props, CSS, and other APIs of this exported module.
Component demos
Import
import ListSubheader from '@mui/material/ListSubheader';
// or
import { ListSubheader } from '@mui/material';
Props of the native component are also available.
Override or extend the styles applied to the component.
See CSS API below for more details.
Type:object
The color of the component. It supports those theme colors that make sense for this component.
Type:'default'
| 'inherit'
| 'primary'
Default:'default'
The component used for the root node. Either a string to use a HTML element or a component.
Type:elementType
If true
, the List Subheader will not stick to the top during scroll.
Type:bool
Default:false
The system prop that allows defining system overrides as well as additional CSS styles.
See the `sx` page for more details.
Type:Array<func
| object
| bool>
| func
| object
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.
Styles applied to the root element if color="inherit"
.
Rule name:colorInherit
Styles applied to the root element if color="primary"
.
Rule name:colorPrimary
Styles applied to the inner component
element unless disableGutters={true}
.
Rule name:gutters
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.