ModalCloseAPI
React ModalClose 组件的 API 参考文档。了解此导出模块的 props、CSS 和其他 API。
演示
导入
import ModalClose from '@mui/joy/ModalClose';
// or
import { ModalClose } from '@mui/joy';阅读关于最小化 bundle 大小的指南，了解它们之间的区别。
也提供原生组件的 Props。
| 名称 | 类型 | 默认 | 描述 |
|---|---|---|---|
| color | 'danger' | 'neutral' | 'primary' | 'success' | 'warning' | string | 'neutral' | 组件的颜色。它支持此组件适用的主题颜色。 要了解如何添加自定义颜色，请查看主题组件—扩展颜色。 |
| component | elementType | - | 用于根节点的组件。可以是用于 HTML 元素的字符串或组件。 |
| size | 'sm' | 'md' | 'lg' | string | 'md' | 组件的尺寸。 要了解如何向组件添加自定义尺寸，请查看主题组件—扩展尺寸。 |
| slotProps | { root?: func | object } | {} | 用于内部每个 slot 的 props。 |
| slots | { root?: elementType } | {} | 用于内部每个 slot 的组件。 有关更多详细信息，请参阅下面的Slots API。 |
| sx | Array<func | object | bool> | func | object | - | 允许定义系统 overrides 以及其他 CSS 样式的系统 prop。 有关更多详细信息，请参阅 `sx` 页面。 |
| variant | 'outlined' | 'plain' | 'soft' | 'solid' | string | 'plain' | 要使用的全局 variant。 要了解如何添加自定义 variants，请查看主题组件—扩展 variants。 |
ref 被转发到根元素。主题默认 props
您可以使用 JoyModalClose 通过主题更改此组件的默认 props。
要了解如何自定义 slot，请查看覆盖组件结构指南。
| Slot 名称 | 类名 | 默认组件 | 描述 |
|---|---|---|---|
| root | .MuiModalClose-root | 'button' | 渲染根元素的组件。 |
这些类名对于使用 CSS 进行样式设置很有用。当触发特定状态时，它们会应用于组件的 slots。
| 类名 | 规则名称 | 描述 |
|---|---|---|
| .MuiModalClose-colorContext | colorContext | 当颜色反转被触发时应用于根元素的类名。 |
| .MuiModalClose-colorDanger | colorDanger | 如果 color="danger"，则应用于根元素的类名。 |
| .MuiModalClose-colorNeutral | colorNeutral | 如果 color="neutral"，则应用于根元素的类名。 |
| .MuiModalClose-colorPrimary | colorPrimary | 如果 color="primary"，则应用于根元素的类名。 |
| .MuiModalClose-colorSuccess | colorSuccess | 如果 color="success"，则应用于根元素的类名。 |
| .MuiModalClose-colorWarning | colorWarning | 如果 color="warning"，则应用于根元素的类名。 |
| .MuiModalClose-sizeLg | sizeLg | 如果 size="lg"，则应用于根元素的类名。 |
| .MuiModalClose-sizeMd | sizeMd | 如果 size="md"，则应用于根元素的类名。 |
| .MuiModalClose-sizeSm | sizeSm | 如果 size="sm"，则应用于根元素的类名。 |
| .MuiModalClose-variantOutlined | variantOutlined | 如果 variant="outlined"，则应用于根元素的类名。 |
| .MuiModalClose-variantPlain | variantPlain | 如果 variant="plain"，则应用于根元素的类名。 |
| .MuiModalClose-variantSoft | variantSoft | 如果 variant="soft"，则应用于根元素的类名。 |
| .MuiModalClose-variantSolid | variantSolid | 如果 variant="solid"，则应用于根元素的类名。 |
您可以使用以下自定义选项之一来覆盖组件的样式
- 使用全局类名。
- 在自定义主题中，将规则名称作为组件的
styleOverrides属性的一部分。
源代码
如果您在此页面中找不到信息，请考虑查看组件的实现以获取更多详细信息。