跳转到内容

ListSubheader API

API documentation for the React ListSubheader component. Learn about the available props, and the CSS API.

Import

import ListSubheader from '@mui/material/ListSubheader';
// 或
import { ListSubheader } from '@mui/material';
You can learn about the difference by reading this guide on minimizing bundle size.

Component name

The name MuiListSubheader can be used when providing default props or style overrides in the theme.

属性

Props of the 原生(Native) component are also available.

名称类型默认值描述
childrennode
The content of the component.
classesobject
Override or extend the styles applied to the component. See CSS 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.
componentelementType
The component used for the root node. Either a string to use a HTML element or a component.
disableGuttersboolfalse
If true, the List Subheader will not have gutters.
disableStickyboolfalse
If true, the List Subheader will not stick to the top during scroll.
insetboolfalse
If true, the List Subheader is indented.
sxArray<func
| object>
| func
| object
The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.

ref 则会被传递到根元素中。

CSS

Rule nameGlobal class描述
root.MuiListSubheader-rootStyles applied to the root element.
colorPrimary.MuiListSubheader-colorPrimaryStyles applied to the root element if color="primary".
colorInherit.MuiListSubheader-colorInheritStyles applied to the root element if color="inherit".
gutters.MuiListSubheader-guttersStyles applied to the inner `component` element unless disableGutters={true}.
inset.MuiListSubheader-insetStyles applied to the root element if inset={true}.
sticky.MuiListSubheader-stickyStyles applied to the root element unless disableSticky={true}.

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

Demos