跳转到内容

Dialog API

想要学习更多组件属性和 CSS API,可以查阅 React Dialog 组件的 API 文档。

导入

import Dialog from '@mui/material/Dialog';
// 或
import { Dialog } from '@mui/material';
你可以阅读这个关于最小化捆绑包的指南以了解以上二者的差异。

Dialogs are overlaid modal paper based components with a backdrop.

组件名称

在主题中,名称“MuiDialog”可用于提供默认属性(props),或者样式覆盖

属性

Modal 组件的属性也是可用的。

名称类型默认值描述
open*boolfalse
Control the popup` open state.
aria-describedbystring
The id(s) of the element(s) that describe the dialog.
aria-labelledbystring
The id(s) of the element(s) that label the dialog.
BackdropComponentelementTypestyled(Backdrop, { name: 'MuiModal', slot: 'Backdrop', overridesResolver: (props, styles) => { return styles.backdrop; }, })({ zIndex: -1, })
A backdrop component. This prop enables custom backdrop rendering.
childrennode
Dialog children, usually the included sub-components.
classesobject
Override or extend the styles applied to the component. See CSS API below for more details.
disableEscapeKeyDownboolfalse
If true, hitting escape will not fire the onClose callback.
fullScreenboolfalse
If true, the dialog is full-screen.
fullWidthboolfalse
If true, the dialog stretches to maxWidth.
Notice that the dialog width grow is limited by the default margin.
maxWidth'xs'
| 'sm'
| 'md'
| 'lg'
| 'xl'
| false
| string
'sm'
Determine the max-width of the dialog. The dialog width grows with the size of the screen. Set to false to disable maxWidth.
onBackdropClickfunc
Callback fired when the backdrop is clicked.
onClosefunc
Callback fired when the component requests to be closed.

Signature:
function(event: object, reason: string) => void
event: The event source of the callback.
reason: Can be: "escapeKeyDown", "backdropClick".
PaperComponentelementTypePaper
The component used to render the body of the dialog.
PaperPropsobject{}
Props applied to the Paper element.
scroll'body'
| 'paper'
'paper'
Determine the container for scrolling the dialog.
sxArray<func
| object
| bool>
| func
| object
The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.
TransitionComponentelementTypeFade
The component used for the transition. Follow this guide to learn more about the requirements for this component.
transitionDurationnumber
| { appear?: number, enter?: number, exit?: number }
{ enter: theme.transitions.duration.enteringScreen, exit: theme.transitions.duration.leavingScreen, }
The duration for the transition, in milliseconds. You may specify a single timeout for all transitions, or individually with an object.
TransitionPropsobject
Props applied to the transition element. By default, the element is based on this Transition component.

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

继承

尽管上文没有明文记录, Modal 组件 的属性(props) 在组件Dialog上同样是可用的。 你可以利用这一点来 指向嵌套组件

CSS

规则名称全局类名描述
root.MuiDialog-rootStyles applied to the root element.
scrollPaper.MuiDialog-scrollPaperStyles applied to the container element if scroll="paper".
scrollBody.MuiDialog-scrollBodyStyles applied to the container element if scroll="body".
container.MuiDialog-containerStyles applied to the container element.
paper.MuiDialog-paperStyles applied to the Paper component.
paperScrollPaper.MuiDialog-paperScrollPaperStyles applied to the Paper component if scroll="paper".
paperScrollBody.MuiDialog-paperScrollBodyStyles applied to the Paper component if scroll="body".
paperWidthFalse.MuiDialog-paperWidthFalseStyles applied to the Paper component if maxWidth=false.
paperWidthXs.MuiDialog-paperWidthXsStyles applied to the Paper component if maxWidth="xs".
paperWidthSm.MuiDialog-paperWidthSmStyles applied to the Paper component if maxWidth="sm".
paperWidthMd.MuiDialog-paperWidthMdStyles applied to the Paper component if maxWidth="md".
paperWidthLg.MuiDialog-paperWidthLgStyles applied to the Paper component if maxWidth="lg".
paperWidthXl.MuiDialog-paperWidthXlStyles applied to the Paper component if maxWidth="xl".
paperFullWidth.MuiDialog-paperFullWidthStyles applied to the Paper component if fullWidth={true}.
paperFullScreen.MuiDialog-paperFullScreenStyles applied to the Paper component if fullScreen={true}.

您可以使用组件自定义选项对组件进行个性化:

演示项目