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/joy/ListSubheader';
// or
import { ListSubheader } from '@mui/joy';

Props of the native component are also available.

Name	Type	Default	Description
children	node	-	The content of the component.
color	'danger' \| 'neutral' \| 'primary' \| 'success' \| 'warning' \| string	-	The color of the component. It supports those theme colors that make sense for this component. To learn how to add your own colors, check out Themed components—Extend colors.
component	elementType	-	The component used for the root node. Either a string to use a HTML element or a component.
slotProps	{ root?: func \| object }	{}	The props used for each slot inside.
slots	{ root?: elementType }	{}	The components used for each slot inside. See Slots API below for more details.
sticky	bool	false	If `true`, the component has sticky position (with top = 0).
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.
variant	'outlined' \| 'plain' \| 'soft' \| 'solid' \| string	-	The global variant to use. To learn how to add your own variants, check out Themed components—Extend variants.

The ref is forwarded to the root element.

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

To learn how to customize the slot, check out the Overriding component structure guide.

Slot name	Class name	Default component	Description
root	.MuiListSubheader-root	`'div'`	The component that renders the root.

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-colorContext	colorContext	Class name applied to the root element when color inversion is triggered.
.MuiListSubheader-colorDanger	colorDanger	Class name applied to the root element if `color="danger"`.
.MuiListSubheader-colorNeutral	colorNeutral	Class name applied to the root element if `color="neutral"`.
.MuiListSubheader-colorPrimary	colorPrimary	Class name applied to the root element if `color="primary"`.
.MuiListSubheader-colorSuccess	colorSuccess	Class name applied to the root element if `color="success"`.
.MuiListSubheader-colorWarning	colorWarning	Class name applied to the root element if `color="warning"`.
.MuiListSubheader-sticky	sticky	Class name applied to the root element, if sticky={true}.
.MuiListSubheader-variantOutlined	variantOutlined	State class applied to the root element if `variant="outlined"`.
.MuiListSubheader-variantPlain	variantPlain	State class applied to the root element if `variant="plain"`.
.MuiListSubheader-variantSoft	variantSoft	State class applied to the root element if `variant="soft"`.
.MuiListSubheader-variantSolid	variantSolid	State class applied to the root element if `variant="solid"`.

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.