Interface: MuiDialogProps
Props for the MuiDialog component.
Extends
DialogProps
Properties
about?
optionalabout?:string
Inherited from
DialogProps.about
accessKey?
optionalaccessKey?:string
Inherited from
DialogProps.accessKey
aria-activedescendant?
optionalaria-activedescendant?:string
Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.
Inherited from
DialogProps.aria-activedescendant
aria-atomic?
optionalaria-atomic?:Booleanish
Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.
Inherited from
DialogProps.aria-atomic
aria-autocomplete?
optionalaria-autocomplete?:"both"|"inline"|"list"|"none"
Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be presented if they are made.
Inherited from
DialogProps.aria-autocomplete
aria-braillelabel?
optionalaria-braillelabel?:string
Defines a string value that labels the current element, which is intended to be converted into Braille.
See
aria-label.
Inherited from
DialogProps.aria-braillelabel
aria-brailleroledescription?
optionalaria-brailleroledescription?:string
Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille.
See
aria-roledescription.
Inherited from
DialogProps.aria-brailleroledescription
aria-busy?
optionalaria-busy?:Booleanish
Inherited from
DialogProps.aria-busy
aria-checked?
optionalaria-checked?:boolean|"false"|"mixed"|"true"
Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.
See
- aria-pressed
- aria-selected.
Inherited from
DialogProps.aria-checked
aria-colcount?
optionalaria-colcount?:number
Defines the total number of columns in a table, grid, or treegrid.
See
aria-colindex.
Inherited from
DialogProps.aria-colcount
aria-colindex?
optionalaria-colindex?:number
Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.
See
- aria-colcount
- aria-colspan.
Inherited from
DialogProps.aria-colindex
aria-colindextext?
optionalaria-colindextext?:string
Defines a human readable text alternative of aria-colindex.
See
aria-rowindextext.
Inherited from
DialogProps.aria-colindextext
aria-colspan?
optionalaria-colspan?:number
Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.
See
- aria-colindex
- aria-rowspan.
Inherited from
DialogProps.aria-colspan
aria-controls?
optionalaria-controls?:string
Identifies the element (or elements) whose contents or presence are controlled by the current element.
See
aria-owns.
Inherited from
DialogProps.aria-controls
aria-current?
optionalaria-current?:boolean|"date"|"false"|"location"|"page"|"step"|"time"|"true"
Indicates the element that represents the current item within a container or set of related elements.
Inherited from
DialogProps.aria-current
aria-describedby?
optionalaria-describedby?:string
The id(s) of the element(s) that describe the dialog.
Inherited from
DialogProps.aria-describedby
aria-description?
optionalaria-description?:string
Defines a string value that describes or annotates the current element.
See
related aria-describedby.
Inherited from
DialogProps.aria-description
aria-details?
optionalaria-details?:string
Identifies the element that provides a detailed, extended description for the object.
See
aria-describedby.
Inherited from
DialogProps.aria-details
aria-disabled?
optionalaria-disabled?:Booleanish
Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.
See
- aria-hidden
- aria-readonly.
Inherited from
DialogProps.aria-disabled
aria-dropeffect?
optionalaria-dropeffect?:"copy"|"execute"|"link"|"move"|"none"|"popup"
Indicates what functions can be performed when a dragged object is released on the drop target.
Deprecated
in ARIA 1.1
Inherited from
DialogProps.aria-dropeffect
aria-errormessage?
optionalaria-errormessage?:string
Identifies the element that provides an error message for the object.
See
- aria-invalid
- aria-describedby.
Inherited from
DialogProps.aria-errormessage
aria-expanded?
optionalaria-expanded?:Booleanish
Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.
Inherited from
DialogProps.aria-expanded
aria-flowto?
optionalaria-flowto?:string
Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, allows assistive technology to override the general default of reading in document source order.
Inherited from
DialogProps.aria-flowto
aria-grabbed?
optionalaria-grabbed?:Booleanish
Indicates an element's "grabbed" state in a drag-and-drop operation.
Deprecated
in ARIA 1.1
Inherited from
DialogProps.aria-grabbed
aria-haspopup?
optionalaria-haspopup?:boolean|"dialog"|"false"|"grid"|"listbox"|"menu"|"tree"|"true"
Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.
Inherited from
DialogProps.aria-haspopup
aria-hidden?
optionalaria-hidden?:Booleanish
Indicates whether the element is exposed to an accessibility API.
See
aria-disabled.
Inherited from
DialogProps.aria-hidden
aria-invalid?
optionalaria-invalid?:boolean|"false"|"grammar"|"spelling"|"true"
Indicates the entered value does not conform to the format expected by the application.
See
aria-errormessage.
Inherited from
DialogProps.aria-invalid
aria-keyshortcuts?
optionalaria-keyshortcuts?:string
Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.
Inherited from
DialogProps.aria-keyshortcuts
aria-label?
optionalaria-label?:string
Defines a string value that labels the current element.
See
aria-labelledby.
Inherited from
DialogProps.aria-label
aria-labelledby?
optionalaria-labelledby?:string
The id(s) of the element(s) that label the dialog.
Inherited from
DialogProps.aria-labelledby
aria-level?
optionalaria-level?:number
Defines the hierarchical level of an element within a structure.
Inherited from
DialogProps.aria-level
aria-live?
optionalaria-live?:"assertive"|"off"|"polite"
Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.
Inherited from
DialogProps.aria-live
aria-modal?
optionalaria-modal?:boolean|"false"|"true"
Informs assistive technologies that the element is modal. It's added on the element with role="dialog".
Default
true
Inherited from
DialogProps.aria-modal
aria-multiline?
optionalaria-multiline?:Booleanish
Indicates whether a text box accepts multiple lines of input or only a single line.
Inherited from
DialogProps.aria-multiline
aria-multiselectable?
optionalaria-multiselectable?:Booleanish
Indicates that the user may select more than one item from the current selectable descendants.
Inherited from
DialogProps.aria-multiselectable
aria-orientation?
optionalaria-orientation?:"horizontal"|"vertical"
Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.
Inherited from
DialogProps.aria-orientation
aria-owns?
optionalaria-owns?:string
Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship between DOM elements where the DOM hierarchy cannot be used to represent the relationship.
See
aria-controls.
Inherited from
DialogProps.aria-owns
aria-placeholder?
optionalaria-placeholder?:string
Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. A hint could be a sample value or a brief description of the expected format.
Inherited from
DialogProps.aria-placeholder
aria-posinset?
optionalaria-posinset?:number
Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.
See
aria-setsize.
Inherited from
DialogProps.aria-posinset
aria-pressed?
optionalaria-pressed?:boolean|"false"|"mixed"|"true"
Indicates the current "pressed" state of toggle buttons.
See
- aria-checked
- aria-selected.
Inherited from
DialogProps.aria-pressed
aria-readonly?
optionalaria-readonly?:Booleanish
Indicates that the element is not editable, but is otherwise operable.
See
aria-disabled.
Inherited from
DialogProps.aria-readonly
aria-relevant?
optionalaria-relevant?:"additions"|"additions removals"|"additions text"|"all"|"removals"|"removals additions"|"removals text"|"text"|"text additions"|"text removals"
Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.
See
aria-atomic.
Inherited from
DialogProps.aria-relevant
aria-required?
optionalaria-required?:Booleanish
Indicates that user input is required on the element before a form may be submitted.
Inherited from
DialogProps.aria-required
aria-roledescription?
optionalaria-roledescription?:string
Defines a human-readable, author-localized description for the role of an element.
Inherited from
DialogProps.aria-roledescription
aria-rowcount?
optionalaria-rowcount?:number
Defines the total number of rows in a table, grid, or treegrid.
See
aria-rowindex.
Inherited from
DialogProps.aria-rowcount
aria-rowindex?
optionalaria-rowindex?:number
Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.
See
- aria-rowcount
- aria-rowspan.
Inherited from
DialogProps.aria-rowindex
aria-rowindextext?
optionalaria-rowindextext?:string
Defines a human readable text alternative of aria-rowindex.
See
aria-colindextext.
Inherited from
DialogProps.aria-rowindextext
aria-rowspan?
optionalaria-rowspan?:number
Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.
See
- aria-rowindex
- aria-colspan.
Inherited from
DialogProps.aria-rowspan
aria-selected?
optionalaria-selected?:Booleanish
Indicates the current "selected" state of various widgets.
See
- aria-checked
- aria-pressed.
Inherited from
DialogProps.aria-selected
aria-setsize?
optionalaria-setsize?:number
Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.
See
aria-posinset.
Inherited from
DialogProps.aria-setsize
aria-sort?
optionalaria-sort?:"ascending"|"descending"|"none"|"other"
Indicates if items in a table or grid are sorted in ascending or descending order.
Inherited from
DialogProps.aria-sort
aria-valuemax?
optionalaria-valuemax?:number
Defines the maximum allowed value for a range widget.
Inherited from
DialogProps.aria-valuemax
aria-valuemin?
optionalaria-valuemin?:number
Defines the minimum allowed value for a range widget.
Inherited from
DialogProps.aria-valuemin
aria-valuenow?
optionalaria-valuenow?:number
Defines the current value for a range widget.
See
aria-valuetext.
Inherited from
DialogProps.aria-valuenow
aria-valuetext?
optionalaria-valuetext?:string
Defines the human readable text alternative of aria-valuenow for a range widget.
Inherited from
DialogProps.aria-valuetext
autoCapitalize?
optionalautoCapitalize?:string&object|"characters"|"none"|"off"|"on"|"sentences"|"words"
Inherited from
DialogProps.autoCapitalize
autoCorrect?
optionalautoCorrect?:string
Inherited from
DialogProps.autoCorrect
autoFocus?
optionalautoFocus?:boolean
Inherited from
DialogProps.autoFocus
autoSave?
optionalautoSave?:string
Inherited from
DialogProps.autoSave
children?
optionalchildren?:ReactNode
Dialog children, usually the included sub-components.
Inherited from
DialogProps.children
classes?
optionalclasses?:Partial<DialogClasses>
Override or extend the styles applied to the component.
Inherited from
DialogProps.classes
closeAfterTransition?
optionalcloseAfterTransition?:boolean
When set to true the Modal waits until a nested Transition is completed before closing.
Default
false
Inherited from
DialogProps.closeAfterTransition
color?
optionalcolor?:string
Inherited from
DialogProps.color
component?
optionalcomponent?:ElementType<any, keyof IntrinsicElements>
Inherited from
DialogProps.component
container?
optionalcontainer?: (() =>Element|null) |Element|null
An HTML element or function that returns one.
The container will have the portal children appended to it.
You can also provide a callback, which is called in a React layout effect. This lets you set the container from a ref, and also makes server-side rendering possible.
By default, it uses the body of the top-level document object,
so it's simply document.body most of the time.
Inherited from
DialogProps.container
content?
optionalcontent?:string
Inherited from
DialogProps.content
contentEditable?
optionalcontentEditable?:Booleanish|"inherit"|"plaintext-only"
Inherited from
DialogProps.contentEditable
contextMenu?
optionalcontextMenu?:string
Inherited from
DialogProps.contextMenu
dangerouslySetInnerHTML?
optionaldangerouslySetInnerHTML?:object
__html
__html:
string|TrustedHTML
Inherited from
DialogProps.dangerouslySetInnerHTML
datatype?
optionaldatatype?:string
Inherited from
DialogProps.datatype
defaultChecked?
optionaldefaultChecked?:boolean
Inherited from
DialogProps.defaultChecked
defaultValue?
optionaldefaultValue?: readonlystring[] |number|string
Inherited from
DialogProps.defaultValue
dir?
optionaldir?:string
Inherited from
DialogProps.dir
disableAutoFocus?
optionaldisableAutoFocus?:boolean
If true, the modal will not automatically shift focus to itself when it opens, and
replace it to the last focused element when it closes.
This also works correctly with any modal children that have the disableAutoFocus prop.
Generally this should never be set to true as it makes the modal less
accessible to assistive technologies, like screen readers.
Default
false
Inherited from
DialogProps.disableAutoFocus
disableEnforceFocus?
optionaldisableEnforceFocus?:boolean
If true, the modal will not prevent focus from leaving the modal while open.
Generally this should never be set to true as it makes the modal less
accessible to assistive technologies, like screen readers.
Default
false
Inherited from
DialogProps.disableEnforceFocus
disablePortal?
optionaldisablePortal?:boolean
The children will be under the DOM hierarchy of the parent component.
Default
false
Inherited from
DialogProps.disablePortal
disableRestoreFocus?
optionaldisableRestoreFocus?:boolean
If true, the modal will not restore focus to previously focused element once
modal is hidden or unmounted.
Default
false
Inherited from
DialogProps.disableRestoreFocus
disableScrollLock?
optionaldisableScrollLock?:boolean
Disable the scroll lock behavior.
Default
false
Inherited from
DialogProps.disableScrollLock
draggable?
optionaldraggable?:Booleanish
Inherited from
DialogProps.draggable
enterKeyHint?
optionalenterKeyHint?:"done"|"enter"|"go"|"next"|"previous"|"search"|"send"
Inherited from
DialogProps.enterKeyHint
exportparts?
optionalexportparts?:string
See
https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/exportparts
Inherited from
DialogProps.exportparts
fullScreen?
optionalfullScreen?:boolean
If true, the dialog is full-screen.
Default
false
Inherited from
DialogProps.fullScreen
fullWidth?
optionalfullWidth?:boolean
If true, the dialog stretches to maxWidth.
Notice that the dialog width grow is limited by the default margin.
Default
false
Inherited from
DialogProps.fullWidth
handleClose?
optionalhandleClose?: () =>void
Custom close handler function.
Returns
void
hidden?
optionalhidden?:boolean
Inherited from
DialogProps.hidden
hideBackdrop?
optionalhideBackdrop?:boolean
If true, the backdrop is not rendered.
Default
false
Inherited from
DialogProps.hideBackdrop
id?
optionalid?:string
Inherited from
DialogProps.id
inert?
optionalinert?:boolean
See
https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/inert
Inherited from
DialogProps.inert
inlist?
optionalinlist?:any
Inherited from
DialogProps.inlist
inputMode?
optionalinputMode?:"decimal"|"email"|"none"|"numeric"|"search"|"tel"|"text"|"url"
Hints at the type of data that might be entered by the user while editing the element or its contents
See
https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute
Inherited from
DialogProps.inputMode
is?
optionalis?:string
Specify that a standard HTML element should behave like a defined custom built-in element
See
https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is
Inherited from
DialogProps.is
itemID?
optionalitemID?:string
Inherited from
DialogProps.itemID
itemProp?
optionalitemProp?:string
Inherited from
DialogProps.itemProp
itemRef?
optionalitemRef?:string
Inherited from
DialogProps.itemRef
itemScope?
optionalitemScope?:boolean
Inherited from
DialogProps.itemScope
itemType?
optionalitemType?:string
Inherited from
DialogProps.itemType
keepMounted?
optionalkeepMounted?:boolean
Always keep the children in the DOM. This prop can be useful in SEO situation or when you want to maximize the responsiveness of the Modal.
Default
false
Inherited from
DialogProps.keepMounted
key?
optionalkey?:Key|null
Inherited from
DialogProps.key
lang?
optionallang?:string
Inherited from
DialogProps.lang
maxWidth?
optionalmaxWidth?:Breakpoint|false
Determine the max-width of the dialog.
The dialog width grows with the size of the screen.
Set to false to disable maxWidth.
Default
'sm'
Inherited from
DialogProps.maxWidth
nonce?
optionalnonce?:string
Inherited from
DialogProps.nonce
onAbort?
optionalonAbort?:ReactEventHandler<HTMLDivElement>
Inherited from
DialogProps.onAbort
onAbortCapture?
optionalonAbortCapture?:ReactEventHandler<HTMLDivElement>
Inherited from
DialogProps.onAbortCapture
onAnimationEnd?
optionalonAnimationEnd?:AnimationEventHandler<HTMLDivElement>
Inherited from
DialogProps.onAnimationEnd
onAnimationEndCapture?
optionalonAnimationEndCapture?:AnimationEventHandler<HTMLDivElement>
Inherited from
DialogProps.onAnimationEndCapture
onAnimationIteration?
optionalonAnimationIteration?:AnimationEventHandler<HTMLDivElement>
Inherited from
DialogProps.onAnimationIteration
onAnimationIterationCapture?
optionalonAnimationIterationCapture?:AnimationEventHandler<HTMLDivElement>
Inherited from
DialogProps.onAnimationIterationCapture
onAnimationStart?
optionalonAnimationStart?:AnimationEventHandler<HTMLDivElement>
Inherited from
DialogProps.onAnimationStart
onAnimationStartCapture?
optionalonAnimationStartCapture?:AnimationEventHandler<HTMLDivElement>
Inherited from
DialogProps.onAnimationStartCapture
onAuxClick?
optionalonAuxClick?:MouseEventHandler<HTMLDivElement>
Inherited from
DialogProps.onAuxClick
onAuxClickCapture?
optionalonAuxClickCapture?:MouseEventHandler<HTMLDivElement>
Inherited from
DialogProps.onAuxClickCapture
onBeforeInput?
optionalonBeforeInput?:InputEventHandler<HTMLDivElement>
Inherited from
DialogProps.onBeforeInput
onBeforeInputCapture?
optionalonBeforeInputCapture?:InputEventHandler<HTMLDivElement>
Inherited from
DialogProps.onBeforeInputCapture
onBeforeToggle?
optionalonBeforeToggle?:ToggleEventHandler<HTMLDivElement>
Inherited from
DialogProps.onBeforeToggle
onBlur?
optionalonBlur?:FocusEventHandler<HTMLDivElement>
Inherited from
DialogProps.onBlur
onBlurCapture?
optionalonBlurCapture?:FocusEventHandler<HTMLDivElement>
Inherited from
DialogProps.onBlurCapture
onCanPlay?
optionalonCanPlay?:ReactEventHandler<HTMLDivElement>
Inherited from
DialogProps.onCanPlay
onCanPlayCapture?
optionalonCanPlayCapture?:ReactEventHandler<HTMLDivElement>
Inherited from
DialogProps.onCanPlayCapture
onCanPlayThrough?
optionalonCanPlayThrough?:ReactEventHandler<HTMLDivElement>
Inherited from
DialogProps.onCanPlayThrough
onCanPlayThroughCapture?
optionalonCanPlayThroughCapture?:ReactEventHandler<HTMLDivElement>
Inherited from
DialogProps.onCanPlayThroughCapture
onChange?
optionalonChange?:ChangeEventHandler<HTMLDivElement,Element>
Inherited from
DialogProps.onChange
onChangeCapture?
optionalonChangeCapture?:ChangeEventHandler<HTMLDivElement,Element>
Inherited from
DialogProps.onChangeCapture
onClick?
optionalonClick?:MouseEventHandler<HTMLDivElement>
Inherited from
DialogProps.onClick
onClickCapture?
optionalonClickCapture?:MouseEventHandler<HTMLDivElement>
Inherited from
DialogProps.onClickCapture
onClose?
optionalonClose?: (event,reason) =>void
Callback fired when the component requests to be closed.
Parameters
event
{ }
The event source of the callback.
reason
"backdropClick" | "escapeKeyDown"
Can be: "escapeKeyDown", "backdropClick".
Returns
void
Inherited from
DialogProps.onClose
onCompositionEnd?
optionalonCompositionEnd?:CompositionEventHandler<HTMLDivElement>
Inherited from
DialogProps.onCompositionEnd
onCompositionEndCapture?
optionalonCompositionEndCapture?:CompositionEventHandler<HTMLDivElement>
Inherited from
DialogProps.onCompositionEndCapture
onCompositionStart?
optionalonCompositionStart?:CompositionEventHandler<HTMLDivElement>
Inherited from
DialogProps.onCompositionStart
onCompositionStartCapture?
optionalonCompositionStartCapture?:CompositionEventHandler<HTMLDivElement>
Inherited from
DialogProps.onCompositionStartCapture
onCompositionUpdate?
optionalonCompositionUpdate?:CompositionEventHandler<HTMLDivElement>
Inherited from
DialogProps.onCompositionUpdate
onCompositionUpdateCapture?
optionalonCompositionUpdateCapture?:CompositionEventHandler<HTMLDivElement>
Inherited from
DialogProps.onCompositionUpdateCapture
onContextMenu?
optionalonContextMenu?:MouseEventHandler<HTMLDivElement>
Inherited from
DialogProps.onContextMenu
onContextMenuCapture?
optionalonContextMenuCapture?:MouseEventHandler<HTMLDivElement>
Inherited from
DialogProps.onContextMenuCapture
onCopy?
optionalonCopy?:ClipboardEventHandler<HTMLDivElement>
Inherited from
DialogProps.onCopy
onCopyCapture?
optionalonCopyCapture?:ClipboardEventHandler<HTMLDivElement>
Inherited from
DialogProps.onCopyCapture
onCut?
optionalonCut?:ClipboardEventHandler<HTMLDivElement>
Inherited from
DialogProps.onCut
onCutCapture?
optionalonCutCapture?:ClipboardEventHandler<HTMLDivElement>
Inherited from
DialogProps.onCutCapture
onDoubleClick?
optionalonDoubleClick?:MouseEventHandler<HTMLDivElement>
Inherited from
DialogProps.onDoubleClick
onDoubleClickCapture?
optionalonDoubleClickCapture?:MouseEventHandler<HTMLDivElement>
Inherited from
DialogProps.onDoubleClickCapture
onDrag?
optionalonDrag?:DragEventHandler<HTMLDivElement>
Inherited from
DialogProps.onDrag
onDragCapture?
optionalonDragCapture?:DragEventHandler<HTMLDivElement>
Inherited from
DialogProps.onDragCapture
onDragEnd?
optionalonDragEnd?:DragEventHandler<HTMLDivElement>
Inherited from
DialogProps.onDragEnd
onDragEndCapture?
optionalonDragEndCapture?:DragEventHandler<HTMLDivElement>
Inherited from
DialogProps.onDragEndCapture
onDragEnter?
optionalonDragEnter?:DragEventHandler<HTMLDivElement>
Inherited from
DialogProps.onDragEnter
onDragEnterCapture?
optionalonDragEnterCapture?:DragEventHandler<HTMLDivElement>
Inherited from
DialogProps.onDragEnterCapture
onDragExit?
optionalonDragExit?:DragEventHandler<HTMLDivElement>
Inherited from
DialogProps.onDragExit
onDragExitCapture?
optionalonDragExitCapture?:DragEventHandler<HTMLDivElement>
Inherited from
DialogProps.onDragExitCapture
onDragLeave?
optionalonDragLeave?:DragEventHandler<HTMLDivElement>
Inherited from
DialogProps.onDragLeave
onDragLeaveCapture?
optionalonDragLeaveCapture?:DragEventHandler<HTMLDivElement>
Inherited from
DialogProps.onDragLeaveCapture
onDragOver?
optionalonDragOver?:DragEventHandler<HTMLDivElement>
Inherited from
DialogProps.onDragOver
onDragOverCapture?
optionalonDragOverCapture?:DragEventHandler<HTMLDivElement>
Inherited from
DialogProps.onDragOverCapture
onDragStart?
optionalonDragStart?:DragEventHandler<HTMLDivElement>
Inherited from
DialogProps.onDragStart
onDragStartCapture?
optionalonDragStartCapture?:DragEventHandler<HTMLDivElement>
Inherited from
DialogProps.onDragStartCapture
onDrop?
optionalonDrop?:DragEventHandler<HTMLDivElement>
Inherited from
DialogProps.onDrop
onDropCapture?
optionalonDropCapture?:DragEventHandler<HTMLDivElement>
Inherited from
DialogProps.onDropCapture
onDurationChange?
optionalonDurationChange?:ReactEventHandler<HTMLDivElement>
Inherited from
DialogProps.onDurationChange
onDurationChangeCapture?
optionalonDurationChangeCapture?:ReactEventHandler<HTMLDivElement>
Inherited from
DialogProps.onDurationChangeCapture
onEmptied?
optionalonEmptied?:ReactEventHandler<HTMLDivElement>
Inherited from
DialogProps.onEmptied
onEmptiedCapture?
optionalonEmptiedCapture?:ReactEventHandler<HTMLDivElement>
Inherited from
DialogProps.onEmptiedCapture
onEncrypted?
optionalonEncrypted?:ReactEventHandler<HTMLDivElement>
Inherited from
DialogProps.onEncrypted
onEncryptedCapture?
optionalonEncryptedCapture?:ReactEventHandler<HTMLDivElement>
Inherited from
DialogProps.onEncryptedCapture
onEnded?
optionalonEnded?:ReactEventHandler<HTMLDivElement>
Inherited from
DialogProps.onEnded
onEndedCapture?
optionalonEndedCapture?:ReactEventHandler<HTMLDivElement>
Inherited from
DialogProps.onEndedCapture
onError?
optionalonError?:ReactEventHandler<HTMLDivElement>
Inherited from
DialogProps.onError
onErrorCapture?
optionalonErrorCapture?:ReactEventHandler<HTMLDivElement>
Inherited from
DialogProps.onErrorCapture
onFocus?
optionalonFocus?:FocusEventHandler<HTMLDivElement>
Inherited from
DialogProps.onFocus
onFocusCapture?
optionalonFocusCapture?:FocusEventHandler<HTMLDivElement>
Inherited from
DialogProps.onFocusCapture
onGotPointerCapture?
optionalonGotPointerCapture?:PointerEventHandler<HTMLDivElement>
Inherited from
DialogProps.onGotPointerCapture
onGotPointerCaptureCapture?
optionalonGotPointerCaptureCapture?:PointerEventHandler<HTMLDivElement>
Inherited from
DialogProps.onGotPointerCaptureCapture
onInput?
optionalonInput?:InputEventHandler<HTMLDivElement>
Inherited from
DialogProps.onInput
onInputCapture?
optionalonInputCapture?:InputEventHandler<HTMLDivElement>
Inherited from
DialogProps.onInputCapture
onInvalid?
optionalonInvalid?:ReactEventHandler<HTMLDivElement>
Inherited from
DialogProps.onInvalid
onInvalidCapture?
optionalonInvalidCapture?:ReactEventHandler<HTMLDivElement>
Inherited from
DialogProps.onInvalidCapture
onKeyDown?
optionalonKeyDown?:KeyboardEventHandler<HTMLDivElement>
Inherited from
DialogProps.onKeyDown
onKeyDownCapture?
optionalonKeyDownCapture?:KeyboardEventHandler<HTMLDivElement>
Inherited from
DialogProps.onKeyDownCapture
onKeyPress?
optionalonKeyPress?:KeyboardEventHandler<HTMLDivElement>
Deprecated
Use onKeyUp or onKeyDown instead
Inherited from
DialogProps.onKeyPress
onKeyPressCapture?
optionalonKeyPressCapture?:KeyboardEventHandler<HTMLDivElement>
Deprecated
Use onKeyUpCapture or onKeyDownCapture instead
Inherited from
DialogProps.onKeyPressCapture
onKeyUp?
optionalonKeyUp?:KeyboardEventHandler<HTMLDivElement>
Inherited from
DialogProps.onKeyUp
onKeyUpCapture?
optionalonKeyUpCapture?:KeyboardEventHandler<HTMLDivElement>
Inherited from
DialogProps.onKeyUpCapture
onLoad?
optionalonLoad?:ReactEventHandler<HTMLDivElement>
Inherited from
DialogProps.onLoad
onLoadCapture?
optionalonLoadCapture?:ReactEventHandler<HTMLDivElement>
Inherited from
DialogProps.onLoadCapture
onLoadedData?
optionalonLoadedData?:ReactEventHandler<HTMLDivElement>
Inherited from
DialogProps.onLoadedData
onLoadedDataCapture?
optionalonLoadedDataCapture?:ReactEventHandler<HTMLDivElement>
Inherited from
DialogProps.onLoadedDataCapture
onLoadedMetadata?
optionalonLoadedMetadata?:ReactEventHandler<HTMLDivElement>
Inherited from
DialogProps.onLoadedMetadata
onLoadedMetadataCapture?
optionalonLoadedMetadataCapture?:ReactEventHandler<HTMLDivElement>
Inherited from
DialogProps.onLoadedMetadataCapture
onLoadStart?
optionalonLoadStart?:ReactEventHandler<HTMLDivElement>
Inherited from
DialogProps.onLoadStart
onLoadStartCapture?
optionalonLoadStartCapture?:ReactEventHandler<HTMLDivElement>
Inherited from
DialogProps.onLoadStartCapture
onLostPointerCapture?
optionalonLostPointerCapture?:PointerEventHandler<HTMLDivElement>
Inherited from
DialogProps.onLostPointerCapture
onLostPointerCaptureCapture?
optionalonLostPointerCaptureCapture?:PointerEventHandler<HTMLDivElement>
Inherited from
DialogProps.onLostPointerCaptureCapture
onMouseDown?
optionalonMouseDown?:MouseEventHandler<HTMLDivElement>
Inherited from
DialogProps.onMouseDown
onMouseDownCapture?
optionalonMouseDownCapture?:MouseEventHandler<HTMLDivElement>
Inherited from
DialogProps.onMouseDownCapture
onMouseEnter?
optionalonMouseEnter?:MouseEventHandler<HTMLDivElement>
Inherited from
DialogProps.onMouseEnter
onMouseLeave?
optionalonMouseLeave?:MouseEventHandler<HTMLDivElement>
Inherited from
DialogProps.onMouseLeave
onMouseMove?
optionalonMouseMove?:MouseEventHandler<HTMLDivElement>
Inherited from
DialogProps.onMouseMove
onMouseMoveCapture?
optionalonMouseMoveCapture?:MouseEventHandler<HTMLDivElement>
Inherited from
DialogProps.onMouseMoveCapture
onMouseOut?
optionalonMouseOut?:MouseEventHandler<HTMLDivElement>
Inherited from
DialogProps.onMouseOut
onMouseOutCapture?
optionalonMouseOutCapture?:MouseEventHandler<HTMLDivElement>
Inherited from
DialogProps.onMouseOutCapture
onMouseOver?
optionalonMouseOver?:MouseEventHandler<HTMLDivElement>
Inherited from
DialogProps.onMouseOver
onMouseOverCapture?
optionalonMouseOverCapture?:MouseEventHandler<HTMLDivElement>
Inherited from
DialogProps.onMouseOverCapture
onMouseUp?
optionalonMouseUp?:MouseEventHandler<HTMLDivElement>
Inherited from
DialogProps.onMouseUp
onMouseUpCapture?
optionalonMouseUpCapture?:MouseEventHandler<HTMLDivElement>
Inherited from
DialogProps.onMouseUpCapture
onOpen?
optionalonOpen?: () =>void
Callback fired when the dialog opens.
Returns
void
onPaste?
optionalonPaste?:ClipboardEventHandler<HTMLDivElement>
Inherited from
DialogProps.onPaste
onPasteCapture?
optionalonPasteCapture?:ClipboardEventHandler<HTMLDivElement>
Inherited from
DialogProps.onPasteCapture
onPause?
optionalonPause?:ReactEventHandler<HTMLDivElement>
Inherited from
DialogProps.onPause
onPauseCapture?
optionalonPauseCapture?:ReactEventHandler<HTMLDivElement>
Inherited from
DialogProps.onPauseCapture
onPlay?
optionalonPlay?:ReactEventHandler<HTMLDivElement>
Inherited from
DialogProps.onPlay
onPlayCapture?
optionalonPlayCapture?:ReactEventHandler<HTMLDivElement>
Inherited from
DialogProps.onPlayCapture
onPlaying?
optionalonPlaying?:ReactEventHandler<HTMLDivElement>
Inherited from
DialogProps.onPlaying
onPlayingCapture?
optionalonPlayingCapture?:ReactEventHandler<HTMLDivElement>
Inherited from
DialogProps.onPlayingCapture
onPointerCancel?
optionalonPointerCancel?:PointerEventHandler<HTMLDivElement>
Inherited from
DialogProps.onPointerCancel
onPointerCancelCapture?
optionalonPointerCancelCapture?:PointerEventHandler<HTMLDivElement>
Inherited from
DialogProps.onPointerCancelCapture
onPointerDown?
optionalonPointerDown?:PointerEventHandler<HTMLDivElement>
Inherited from
DialogProps.onPointerDown
onPointerDownCapture?
optionalonPointerDownCapture?:PointerEventHandler<HTMLDivElement>
Inherited from
DialogProps.onPointerDownCapture
onPointerEnter?
optionalonPointerEnter?:PointerEventHandler<HTMLDivElement>
Inherited from
DialogProps.onPointerEnter
onPointerLeave?
optionalonPointerLeave?:PointerEventHandler<HTMLDivElement>
Inherited from
DialogProps.onPointerLeave
onPointerMove?
optionalonPointerMove?:PointerEventHandler<HTMLDivElement>
Inherited from
DialogProps.onPointerMove
onPointerMoveCapture?
optionalonPointerMoveCapture?:PointerEventHandler<HTMLDivElement>
Inherited from
DialogProps.onPointerMoveCapture
onPointerOut?
optionalonPointerOut?:PointerEventHandler<HTMLDivElement>
Inherited from
DialogProps.onPointerOut
onPointerOutCapture?
optionalonPointerOutCapture?:PointerEventHandler<HTMLDivElement>
Inherited from
DialogProps.onPointerOutCapture
onPointerOver?
optionalonPointerOver?:PointerEventHandler<HTMLDivElement>
Inherited from
DialogProps.onPointerOver
onPointerOverCapture?
optionalonPointerOverCapture?:PointerEventHandler<HTMLDivElement>
Inherited from
DialogProps.onPointerOverCapture
onPointerUp?
optionalonPointerUp?:PointerEventHandler<HTMLDivElement>
Inherited from
DialogProps.onPointerUp
onPointerUpCapture?
optionalonPointerUpCapture?:PointerEventHandler<HTMLDivElement>
Inherited from
DialogProps.onPointerUpCapture
onProgress?
optionalonProgress?:ReactEventHandler<HTMLDivElement>
Inherited from
DialogProps.onProgress
onProgressCapture?
optionalonProgressCapture?:ReactEventHandler<HTMLDivElement>
Inherited from
DialogProps.onProgressCapture
onRateChange?
optionalonRateChange?:ReactEventHandler<HTMLDivElement>
Inherited from
DialogProps.onRateChange
onRateChangeCapture?
optionalonRateChangeCapture?:ReactEventHandler<HTMLDivElement>
Inherited from
DialogProps.onRateChangeCapture
onReset?
optionalonReset?:ReactEventHandler<HTMLDivElement>
Inherited from
DialogProps.onReset
onResetCapture?
optionalonResetCapture?:ReactEventHandler<HTMLDivElement>
Inherited from
DialogProps.onResetCapture
onScroll?
optionalonScroll?:UIEventHandler<HTMLDivElement>
Inherited from
DialogProps.onScroll
onScrollCapture?
optionalonScrollCapture?:UIEventHandler<HTMLDivElement>
Inherited from
DialogProps.onScrollCapture
onScrollEnd?
optionalonScrollEnd?:UIEventHandler<HTMLDivElement>
Inherited from
DialogProps.onScrollEnd
onScrollEndCapture?
optionalonScrollEndCapture?:UIEventHandler<HTMLDivElement>
Inherited from
DialogProps.onScrollEndCapture
onSeeked?
optionalonSeeked?:ReactEventHandler<HTMLDivElement>
Inherited from
DialogProps.onSeeked
onSeekedCapture?
optionalonSeekedCapture?:ReactEventHandler<HTMLDivElement>
Inherited from
DialogProps.onSeekedCapture
onSeeking?
optionalonSeeking?:ReactEventHandler<HTMLDivElement>
Inherited from
DialogProps.onSeeking
onSeekingCapture?
optionalonSeekingCapture?:ReactEventHandler<HTMLDivElement>
Inherited from
DialogProps.onSeekingCapture
onSelect?
optionalonSelect?:ReactEventHandler<HTMLDivElement>
Inherited from
DialogProps.onSelect
onSelectCapture?
optionalonSelectCapture?:ReactEventHandler<HTMLDivElement>
Inherited from
DialogProps.onSelectCapture
onStalled?
optionalonStalled?:ReactEventHandler<HTMLDivElement>
Inherited from
DialogProps.onStalled
onStalledCapture?
optionalonStalledCapture?:ReactEventHandler<HTMLDivElement>
Inherited from
DialogProps.onStalledCapture
onSubmit?
optionalonSubmit?:SubmitEventHandler<HTMLDivElement>
Inherited from
DialogProps.onSubmit
onSubmitCapture?
optionalonSubmitCapture?:SubmitEventHandler<HTMLDivElement>
Inherited from
DialogProps.onSubmitCapture
onSuspend?
optionalonSuspend?:ReactEventHandler<HTMLDivElement>
Inherited from
DialogProps.onSuspend
onSuspendCapture?
optionalonSuspendCapture?:ReactEventHandler<HTMLDivElement>
Inherited from
DialogProps.onSuspendCapture
onTimeUpdate?
optionalonTimeUpdate?:ReactEventHandler<HTMLDivElement>
Inherited from
DialogProps.onTimeUpdate
onTimeUpdateCapture?
optionalonTimeUpdateCapture?:ReactEventHandler<HTMLDivElement>
Inherited from
DialogProps.onTimeUpdateCapture
onToggle?
optionalonToggle?:ToggleEventHandler<HTMLDivElement>
Inherited from
DialogProps.onToggle
onTouchCancel?
optionalonTouchCancel?:TouchEventHandler<HTMLDivElement>
Inherited from
DialogProps.onTouchCancel
onTouchCancelCapture?
optionalonTouchCancelCapture?:TouchEventHandler<HTMLDivElement>
Inherited from
DialogProps.onTouchCancelCapture
onTouchEnd?
optionalonTouchEnd?:TouchEventHandler<HTMLDivElement>
Inherited from
DialogProps.onTouchEnd
onTouchEndCapture?
optionalonTouchEndCapture?:TouchEventHandler<HTMLDivElement>
Inherited from
DialogProps.onTouchEndCapture
onTouchMove?
optionalonTouchMove?:TouchEventHandler<HTMLDivElement>
Inherited from
DialogProps.onTouchMove
onTouchMoveCapture?
optionalonTouchMoveCapture?:TouchEventHandler<HTMLDivElement>
Inherited from
DialogProps.onTouchMoveCapture
onTouchStart?
optionalonTouchStart?:TouchEventHandler<HTMLDivElement>
Inherited from
DialogProps.onTouchStart
onTouchStartCapture?
optionalonTouchStartCapture?:TouchEventHandler<HTMLDivElement>
Inherited from
DialogProps.onTouchStartCapture
onTransitionCancel?
optionalonTransitionCancel?:TransitionEventHandler<HTMLDivElement>
Inherited from
DialogProps.onTransitionCancel
onTransitionCancelCapture?
optionalonTransitionCancelCapture?:TransitionEventHandler<HTMLDivElement>
Inherited from
DialogProps.onTransitionCancelCapture
onTransitionEnd?
optionalonTransitionEnd?:TransitionEventHandler<HTMLDivElement>
Inherited from
DialogProps.onTransitionEnd
onTransitionEndCapture?
optionalonTransitionEndCapture?:TransitionEventHandler<HTMLDivElement>
Inherited from
DialogProps.onTransitionEndCapture
onTransitionEnter?
optionalonTransitionEnter?: () =>void
A function called when a transition enters.
Returns
void
Inherited from
DialogProps.onTransitionEnter
onTransitionExited?
optionalonTransitionExited?: () =>void
A function called when a transition has exited.
Returns
void
Inherited from
DialogProps.onTransitionExited
onTransitionRun?
optionalonTransitionRun?:TransitionEventHandler<HTMLDivElement>
Inherited from
DialogProps.onTransitionRun
onTransitionRunCapture?
optionalonTransitionRunCapture?:TransitionEventHandler<HTMLDivElement>
Inherited from
DialogProps.onTransitionRunCapture
onTransitionStart?
optionalonTransitionStart?:TransitionEventHandler<HTMLDivElement>
Inherited from
DialogProps.onTransitionStart
onTransitionStartCapture?
optionalonTransitionStartCapture?:TransitionEventHandler<HTMLDivElement>
Inherited from
DialogProps.onTransitionStartCapture
onVolumeChange?
optionalonVolumeChange?:ReactEventHandler<HTMLDivElement>
Inherited from
DialogProps.onVolumeChange
onVolumeChangeCapture?
optionalonVolumeChangeCapture?:ReactEventHandler<HTMLDivElement>
Inherited from
DialogProps.onVolumeChangeCapture
onWaiting?
optionalonWaiting?:ReactEventHandler<HTMLDivElement>
Inherited from
DialogProps.onWaiting
onWaitingCapture?
optionalonWaitingCapture?:ReactEventHandler<HTMLDivElement>
Inherited from
DialogProps.onWaitingCapture
onWheel?
optionalonWheel?:WheelEventHandler<HTMLDivElement>
Inherited from
DialogProps.onWheel
onWheelCapture?
optionalonWheelCapture?:WheelEventHandler<HTMLDivElement>
Inherited from
DialogProps.onWheelCapture
open
open:
boolean
If true, the component is shown.
Inherited from
DialogProps.open
PaperComponent?
optionalPaperComponent?:JSXElementConstructor<PaperProps>
The component used to render the body of the dialog.
Default
Paper
Inherited from
DialogProps.PaperComponent
part?
optionalpart?:string
See
https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/part
Inherited from
DialogProps.part
popover?
optionalpopover?:""|"auto"|"hint"|"manual"
Inherited from
DialogProps.popover
popoverTarget?
optionalpopoverTarget?:string
Inherited from
DialogProps.popoverTarget
popoverTargetAction?
optionalpopoverTargetAction?:"hide"|"show"|"toggle"
Inherited from
DialogProps.popoverTargetAction
prefix?
optionalprefix?:string
Inherited from
DialogProps.prefix
property?
optionalproperty?:string
Inherited from
DialogProps.property
radioGroup?
optionalradioGroup?:string
Inherited from
DialogProps.radioGroup
ref?
optionalref?: ((instance) => (() =>VoidOrUndefinedOnly) |void) |null|RefObject<HTMLDivElement|null>
Allows getting a ref to the component instance.
Once the component unmounts, React will set ref.current to null
(or call the ref with null if you passed a callback ref).
See
Inherited from
DialogProps.ref
rel?
optionalrel?:string
Inherited from
DialogProps.rel
resource?
optionalresource?:string
Inherited from
DialogProps.resource
results?
optionalresults?:number
Inherited from
DialogProps.results
rev?
optionalrev?:string
Inherited from
DialogProps.rev
role?
optionalrole?:"alertdialog"|"dialog"
The ARIA role for the dialog element.
The main dialog role is dialog, but alertdialog can be used if the content of the dialog requires immediate attention.
See https://www.w3.org/TR/wai-aria-1.2/#dialog and https://www.w3.org/TR/wai-aria-1.2/#alertdialog for more details.
Default
'dialog'
Inherited from
DialogProps.role
scroll?
optionalscroll?:"body"|"paper"
Determine the container for scrolling the dialog.
Default
'paper'
Inherited from
DialogProps.scroll
security?
optionalsecurity?:string
Inherited from
DialogProps.security
slot?
optionalslot?:string
Inherited from
DialogProps.slot
slotProps?
optionalslotProps?:object
The props used for each slot inside.
backdrop?
optionalbackdrop?:SlotProps<ElementType<BackdropProps, keyof IntrinsicElements>,DialogBackdropSlotPropsOverrides,DialogOwnerState>
Props forwarded to the backdrop slot. By default, the available props are based on the Backdrop component.
container?
optionalcontainer?:SlotProps<"div",DialogContainerSlotPropsOverrides,DialogOwnerState>
Props forwarded to the container slot. By default, the available props are based on a div element.
paper?
optionalpaper?:SlotProps<ElementType<PaperProps, keyof IntrinsicElements>,DialogPaperSlotPropsOverrides,DialogOwnerState>
Props forwarded to the paper slot. By default, the available props are based on the Paper component.
root?
optionalroot?:SlotProps<ElementType<ModalProps, keyof IntrinsicElements>,DialogRootSlotPropsOverrides,DialogOwnerState>
Props forwarded to the root slot. By default, the available props are based on the Modal component.
transition?
optionaltransition?:SlotComponentProps<ElementType<TransitionProps, keyof IntrinsicElements>,TransitionProps&DialogTransitionSlotPropsOverrides,DialogOwnerState>
Props forwarded to the transition slot. By default, the available props are based on the Fade component.
Default
{}
Inherited from
DialogProps.slotProps
slots?
optionalslots?:Partial<DialogSlots>
The components used for each slot inside.
Default
{}
Inherited from
DialogProps.slots
spellCheck?
optionalspellCheck?:Booleanish
Inherited from
DialogProps.spellCheck
style?
optionalstyle?:CSSProperties
Inherited from
DialogProps.style
suppressContentEditableWarning?
optionalsuppressContentEditableWarning?:boolean
Inherited from
DialogProps.suppressContentEditableWarning
suppressHydrationWarning?
optionalsuppressHydrationWarning?:boolean
Inherited from
DialogProps.suppressHydrationWarning
sx?
optionalsx?:SxProps<Theme>
The system prop that allows defining system overrides as well as additional CSS styles.
Inherited from
DialogProps.sx
tabIndex?
optionaltabIndex?:number
Inherited from
DialogProps.tabIndex
title?
optionaltitle?:string
Inherited from
DialogProps.title
transitionDuration?
optionaltransitionDuration?: {appear?:number;enter?:number;exit?:number; } |number
The duration for the transition, in milliseconds. You may specify a single timeout for all transitions, or individually with an object.
Default
{
* enter: theme.transitions.duration.enteringScreen,
* exit: theme.transitions.duration.leavingScreen,
* }
Inherited from
DialogProps.transitionDuration
translate?
optionaltranslate?:"no"|"yes"
Inherited from
DialogProps.translate
typeof?
optionaltypeof?:string
Inherited from
DialogProps.typeof
unselectable?
optionalunselectable?:"off"|"on"
Inherited from
DialogProps.unselectable
vocab?
optionalvocab?:string
Inherited from
DialogProps.vocab