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.

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

children

The content of the component.

Type:node

color

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.

Type:'danger'
| 'neutral'
| 'primary'
| 'success'
| 'warning'
| string

component

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

Type:elementType

slotProps

The props used for each slot inside.

Type:{ root?: func
| object }

Default:{}

slots

The components used for each slot inside.

See Slots API below for more details.

Type:{ root?: elementType }

Default:{}

sticky

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

Type:bool

Default:false

sx

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

variant

The global variant to use.

To learn how to add your own variants, check out Themed components—Extend variants.

Type:'outlined'
| 'plain'
| 'soft'
| 'solid'
| string

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.

root

The component that renders the root.

Class name: .MuiListSubheader-root

Default component: 'div'

CSS classes

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

.MuiListSubheader-colorContext

Class name applied to the root element when color inversion is triggered.

Rule name:colorContext

.MuiListSubheader-colorDanger

Class name applied to the root element if color="danger".

Rule name:colorDanger

.MuiListSubheader-colorNeutral

Class name applied to the root element if color="neutral".

Rule name:colorNeutral

.MuiListSubheader-colorPrimary

Class name applied to the root element if color="primary".

Rule name:colorPrimary

.MuiListSubheader-colorSuccess

Class name applied to the root element if color="success".

Rule name:colorSuccess

.MuiListSubheader-colorWarning

Class name applied to the root element if color="warning".

Rule name:colorWarning

.MuiListSubheader-sticky

Class name applied to the root element, if sticky={true}.

Rule name:sticky

.MuiListSubheader-variantOutlined

State class applied to the root element if variant="outlined".

Rule name:variantOutlined

.MuiListSubheader-variantPlain

State class applied to the root element if variant="plain".

Rule name:variantPlain

.MuiListSubheader-variantSoft

State class applied to the root element if variant="soft".

Rule name:variantSoft

.MuiListSubheader-variantSolid

State class applied to the root element if variant="solid".

Rule name:variantSolid


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