跳到内容跳到内容

ListSubheaderAPI

React ListSubheader 组件的 API 参考文档。了解此导出的模块的 props、CSS 和其他 API。

演示

Import

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

通过阅读关于最小化 bundle 大小的指南,了解更多差异。

Props

原生组件的 Props 也可用。

名称类型默认值描述
childrennode-

组件的内容。

color'danger'
| 'neutral'
| 'primary'
| 'success'
| 'warning'
| string
-

组件的颜色。它支持那些对此组件有意义的主题颜色。

要了解如何添加您自己的颜色,请查看主题组件—扩展颜色

componentelementType-

用于根节点的组件。可以使用 HTML 元素的字符串或组件。

slotProps{ root?: func
| object }
{}

用于内部每个 slot 的 props。

slots{ root?: elementType }{}

用于内部每个 slot 的组件。

有关更多详细信息,请参阅下面的Slots API

stickyboolfalse

如果为 true,则组件具有粘性定位 (top = 0)。

sxArray<func
| object
| bool>
| func
| object
-

允许定义系统覆盖以及其他 CSS 样式的系统 prop。

有关更多详细信息,请参阅`sx` 页面

variant'outlined'
| 'plain'
| 'soft'
| 'solid'
| string
-

要使用的全局 variant

要了解如何添加您自己的 variants,请查看主题组件—扩展 variants

ref 被转发到根元素。

主题默认 props

您可以使用 JoyListSubheader 通过主题更改此组件的默认 props。

Slots

要了解如何自定义 slot,请查看覆盖组件结构指南。

Slot 名称Class 名称默认组件描述
root.MuiListSubheader-root'div'渲染 root 的组件。

CSS classes

这些 class 名称对于使用 CSS 进行样式设置很有用。当触发特定状态时,它们将应用于组件的 slots。

Class 名称规则名称描述
.MuiListSubheader-colorContextcolorContext当颜色反转被触发时,应用于根元素的 Class 名称。
.MuiListSubheader-colorDangercolorDanger如果 color="danger",则应用于根元素的 Class 名称。
.MuiListSubheader-colorNeutralcolorNeutral如果 color="neutral",则应用于根元素的 Class 名称。
.MuiListSubheader-colorPrimarycolorPrimary如果 color="primary",则应用于根元素的 Class 名称。
.MuiListSubheader-colorSuccesscolorSuccess如果 color="success",则应用于根元素的 Class 名称。
.MuiListSubheader-colorWarningcolorWarning如果 color="warning",则应用于根元素的 Class 名称。
.MuiListSubheader-stickysticky如果 sticky={true},则应用于根元素的 Class 名称。
.MuiListSubheader-variantOutlinedvariantOutlined如果 variant="outlined",则应用于根元素的状态 class。
.MuiListSubheader-variantPlainvariantPlain如果 variant="plain",则应用于根元素的状态 class。
.MuiListSubheader-variantSoftvariantSoft如果 variant="soft",则应用于根元素的状态 class。
.MuiListSubheader-variantSolidvariantSolid如果 variant="solid",则应用于根元素的状态 class。

您可以使用以下自定义选项之一来覆盖组件的样式

源代码

如果您在此页面中没有找到所需的信息,请考虑查看组件的实现以获取更多详细信息。