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

Import

import ListSubheader from '@mui/joy/ListSubheader';
// or
import { ListSubheader } from '@mui/joy';

Learn about the difference by reading this guide on minimizing bundle size.

Props

Props of the native component are also available.

NameTypeDefaultDescription
childrennode-

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.

componentelementType-

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.

stickyboolfalse

If true, the component has sticky position (with top = 0).

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.

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.

Theme default props

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

Slots

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

Slot nameClass nameDefault componentDescription
root.MuiListSubheader-root'div'The component that renders the root.

CSS classes

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

Class nameRule nameDescription
.MuiListSubheader-colorContextcolorContextClass name applied to the root element when color inversion is triggered.
.MuiListSubheader-colorDangercolorDangerClass name applied to the root element if color="danger".
.MuiListSubheader-colorNeutralcolorNeutralClass name applied to the root element if color="neutral".
.MuiListSubheader-colorPrimarycolorPrimaryClass name applied to the root element if color="primary".
.MuiListSubheader-colorSuccesscolorSuccessClass name applied to the root element if color="success".
.MuiListSubheader-colorWarningcolorWarningClass name applied to the root element if color="warning".
.MuiListSubheader-stickystickyClass name applied to the root element, if sticky={true}.
.MuiListSubheader-variantOutlinedvariantOutlinedState class applied to the root element if variant="outlined".
.MuiListSubheader-variantPlainvariantPlainState class applied to the root element if variant="plain".
.MuiListSubheader-variantSoftvariantSoftState class applied to the root element if variant="soft".
.MuiListSubheader-variantSolidvariantSolidState class applied to the root element if variant="solid".

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

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.