Skip to contentSkip to content

SheetAPI

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

演示

导入

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

通过阅读关于最小化捆绑包大小的指南,了解它们之间的区别。

Props

原生组件的 Props 也可用。

名称类型默认值描述
childrennode-

组件的内容。

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

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

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

componentelementType-

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

invertedColorsboolfalse

如果 true,则带有隐式 color prop 的子组件会反转其颜色以匹配组件的 variant 和 color。

slotProps{ root?: func
| object }
{}

用于内部每个插槽的 props。

slots{ root?: elementType }{}

用于内部每个插槽的组件。

有关更多详细信息,请参见下面的插槽 API

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

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

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

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

要使用的全局 variant

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

ref 被转发到根元素。

主题默认 props

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

插槽

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

插槽名称类名默认组件描述
root.MuiSheet-root'div'渲染根的组件。

CSS 类

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

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

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

源代码

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