跳到内容跳到内容
🚀 影响 Joy UI 2025 年路线图！参与最新的开发者调查

ListAPI

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

演示

Import

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

通过阅读关于最小化 bundle size 的指南，了解它们之间的区别。

Props

原生组件的 Props 也可用。

名称类型默认值描述
childrennode-

组件的内容。

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

组件的颜色。它支持对该组件有意义的主题颜色。

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

componentelementType-

用于根节点的组件。可以是用于 HTML 元素的字符串，也可以是组件。

markerstring-

列表项的标记（例如圆点、字符或自定义计数器样式）。当指定此 prop 时，ListItem 会将 CSS display 更改为 list-item 以应用标记。
要查看所有可用选项，请查看 MDN list-style-type 页面。

orientation'horizontal'
| 'vertical'		'vertical'

组件方向。

size'sm'
| 'md'
| 'lg'
| string		'md'

组件的大小（影响其他嵌套的 list* 组件）。

要了解如何向组件添加自定义尺寸，请查看主题组件—扩展尺寸。

slotProps{ root?: func
| object }		{}

用于内部每个 slot 的 props。

slots{ root?: elementType }{}

用于内部每个 slot 的组件。

有关更多详细信息，请参见下面的Slots API。

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

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

有关更多详细信息，请参见 `sx` 页面。

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

要使用的全局变体。

要了解如何添加自己的变体，请查看主题组件—扩展变体。

wrapboolfalse

仅用于水平列表。如果为 true，则列表将 flex-wrap 设置为 "wrap" 并调整 margin 以具有类似 gap 的行为（将来会移至 gap）。

ref 被转发到根元素。

主题默认 props

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

Slots

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

Slot 名称类名默认组件描述
root.MuiList-root'ul'渲染根的组件。

CSS 类

这些类名对于使用 CSS 设置样式很有用。当触发特定状态时，它们会应用于组件的 slot。

类名规则名称描述
.MuiList-colorContextcolorContext当颜色反转被触发时，应用于根元素的类名。
.MuiList-colorDangercolorDanger如果 color="danger"，则应用于根元素的类名。
.MuiList-colorNeutralcolorNeutral如果 color="neutral"，则应用于根元素的类名。
.MuiList-colorPrimarycolorPrimary如果 color="primary"，则应用于根元素的类名。
.MuiList-colorSuccesscolorSuccess如果 color="success"，则应用于根元素的类名。
.MuiList-colorWarningcolorWarning如果 color="warning"，则应用于根元素的类名。
.MuiList-horizontalhorizontal如果 orientation="horizontal"，则应用于根元素的类名。
.MuiList-nestingnesting如果用嵌套上下文包装，则应用于根元素的类名。
.MuiList-scopedscoped如果 scoped 为 true，则应用于根元素的类名。
.MuiList-sizeLgsizeLg如果 size="lg"，则应用于根元素的类名。
.MuiList-sizeMdsizeMd如果 size="md"，则应用于根元素的类名。
.MuiList-sizeSmsizeSm如果 size="sm"，则应用于根元素的类名。
.MuiList-variantOutlinedvariantOutlined如果 variant="outlined"，则应用于根元素的类名。
.MuiList-variantPlainvariantPlain如果 variant="plain"，则应用于根元素的类名。
.MuiList-variantSoftvariantSoft如果 variant="soft"，则应用于根元素的类名。
.MuiList-variantSolidvariantSolid如果 variant="solid"，则应用于根元素的类名。
.MuiList-verticalvertical如果 orientation="vertical"，则应用于根元素的类名。

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

源代码

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