Name | Type | Default | Description |
---|---|---|---|
onClose required | () => void | Called when modal/drawer is closed | |
opened required | boolean | Determines whether modal/drawer is opened | |
"aria-activedescendant" | string | Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application. | |
"aria-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. | |
"aria-autocomplete" | "none" | "inline" | "list" | "both" | 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. | |
"aria-busy" | Booleanish | Indicates an element is being modified and that assistive technologies MAY want to wait until the modifications are complete before exposing them to the user. | |
"aria-checked" | boolean | "true" | "false" | "mixed" | Indicates the current "checked" state of checkboxes, radio buttons, and other widgets. | |
"aria-colcount" | number | Defines the total number of columns in a table, grid, or treegrid. | |
"aria-colindex" | number | Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid. | |
"aria-colspan" | number | Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid. | |
"aria-controls" | string | Identifies the element (or elements) whose contents or presence are controlled by the current element. | |
"aria-current" | boolean | "time" | "true" | "false" | "page" | "step" | "location" | "date" | Indicates the element that represents the current item within a container or set of related elements. | |
"aria-describedby" | string | Identifies the element (or elements) that describes the object. | |
"aria-details" | string | Identifies the element that provides a detailed, extended description for the object. | |
"aria-disabled" | Booleanish | Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable. | |
"aria-errormessage" | string | Identifies the element that provides an error message for the object. | |
"aria-expanded" | Booleanish | Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed. | |
"aria-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. | |
"aria-haspopup" | boolean | "dialog" | "menu" | "true" | "false" | "listbox" | "tree" | "grid" | Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element. | |
"aria-hidden" | Booleanish | Indicates whether the element is exposed to an accessibility API. | |
"aria-invalid" | boolean | "true" | "false" | "grammar" | "spelling" | Indicates the entered value does not conform to the format expected by the application. | |
"aria-keyshortcuts" | string | Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element. | |
"aria-label" | string | Defines a string value that labels the current element. | |
"aria-labelledby" | string | Identifies the element (or elements) that labels the current element. | |
"aria-level" | number | Defines the hierarchical level of an element within a structure. | |
"aria-live" | "off" | "assertive" | "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. | |
"aria-modal" | Booleanish | Indicates whether an element is modal when displayed. | |
"aria-multiline" | Booleanish | Indicates whether a text box accepts multiple lines of input or only a single line. | |
"aria-multiselectable" | Booleanish | Indicates that the user may select more than one item from the current selectable descendants. | |
"aria-orientation" | "horizontal" | "vertical" | Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous. | |
"aria-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. | |
"aria-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. | |
"aria-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. | |
"aria-pressed" | boolean | "true" | "false" | "mixed" | Indicates the current "pressed" state of toggle buttons. | |
"aria-readonly" | Booleanish | Indicates that the element is not editable, but is otherwise operable. | |
"aria-relevant" | "text" | "additions" | "additions removals" | "additions text" | "all" | "removals" | "removals additions" | "removals text" | "text additions" | "text removals" | Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified. | |
"aria-required" | Booleanish | Indicates that user input is required on the element before a form may be submitted. | |
"aria-roledescription" | string | Defines a human-readable, author-localized description for the role of an element. | |
"aria-rowcount" | number | Defines the total number of rows in a table, grid, or treegrid. | |
"aria-rowindex" | number | Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid. | |
"aria-rowspan" | number | Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid. | |
"aria-selected" | Booleanish | Indicates the current "selected" state of various widgets. | |
"aria-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. | |
"aria-sort" | "none" | "ascending" | "descending" | "other" | Indicates if items in a table or grid are sorted in ascending or descending order. | |
"aria-valuemax" | number | Defines the maximum allowed value for a range widget. | |
"aria-valuemin" | number | Defines the minimum allowed value for a range widget. | |
"aria-valuenow" | number | Defines the current value for a range widget. | |
"aria-valuetext" | string | Defines the human readable text alternative of aria-valuenow for a range widget. | |
about | string | ||
accessKey | string | ||
autoCapitalize | string | ||
autoCorrect | string | ||
autoSave | string | ||
centered | boolean | Determines whether the modal should be centered vertically, false by default | |
children | ReactNode | Modal content | |
className | string | ||
classNames | ClassNames<any> | ||
closeButtonProps | ModalBaseCloseButtonProps | Props added to close button | |
closeOnClickOutside | boolean | Determines whether the modal/drawer should be closed when user clicks on the overlay, true by default | |
closeOnEscape | boolean | Determines whether onClose should be called when user presses escape key, true by default | |
color | string | ||
contentEditable | Booleanish | "inherit" | ||
contextMenu | string | ||
dangerouslySetInnerHTML | { __html: string; } | ||
datatype | string | ||
defaultChecked | boolean | ||
defaultValue | string | number | readonly string[] | ||
dir | string | ||
draggable | Booleanish | ||
fullScreen | boolean | Determines whether the modal should take the entire screen | |
hidden | boolean | ||
id | string | Id used to connect modal/drawer with body and title | |
inlist | any | ||
inputMode | "text" | "none" | "tel" | "url" | "email" | "numeric" | "decimal" | "search" | Hints at the type of data that might be entered by the user while editing the element or its contents | |
is | string | Specify that a standard HTML element should behave like a defined custom built-in element | |
itemID | string | ||
itemProp | string | ||
itemRef | string | ||
itemScope | boolean | ||
itemType | string | ||
keepMounted | boolean | If set modal/drawer will not be unmounted from the DOM when it is hidden, display: none styles will be added instead | |
key | Key | ||
lang | string | ||
lockScroll | boolean | Determines whether scroll should be locked when opened={true}, defaults to true | |
nonce | string | ||
onAbort | ReactEventHandler<HTMLDivElement> | ||
onAbortCapture | ReactEventHandler<HTMLDivElement> | ||
onAnimationEnd | AnimationEventHandler<HTMLDivElement> | ||
onAnimationEndCapture | AnimationEventHandler<HTMLDivElement> | ||
onAnimationIteration | AnimationEventHandler<HTMLDivElement> | ||
onAnimationIterationCapture | AnimationEventHandler<HTMLDivElement> | ||
onAnimationStart | AnimationEventHandler<HTMLDivElement> | ||
onAnimationStartCapture | AnimationEventHandler<HTMLDivElement> | ||
onAuxClick | MouseEventHandler<HTMLDivElement> | ||
onAuxClickCapture | MouseEventHandler<HTMLDivElement> | ||
onBeforeInput | FormEventHandler<HTMLDivElement> | ||
onBeforeInputCapture | FormEventHandler<HTMLDivElement> | ||
onBlur | FocusEventHandler<HTMLDivElement> | ||
onBlurCapture | FocusEventHandler<HTMLDivElement> | ||
onCanPlay | ReactEventHandler<HTMLDivElement> | ||
onCanPlayCapture | ReactEventHandler<HTMLDivElement> | ||
onCanPlayThrough | ReactEventHandler<HTMLDivElement> | ||
onCanPlayThroughCapture | ReactEventHandler<HTMLDivElement> | ||
onChange | FormEventHandler<HTMLDivElement> | ||
onChangeCapture | FormEventHandler<HTMLDivElement> | ||
onClick | MouseEventHandler<HTMLDivElement> | ||
onClickCapture | MouseEventHandler<HTMLDivElement> | ||
onCompositionEnd | CompositionEventHandler<HTMLDivElement> | ||
onCompositionEndCapture | CompositionEventHandler<HTMLDivElement> | ||
onCompositionStart | CompositionEventHandler<HTMLDivElement> | ||
onCompositionStartCapture | CompositionEventHandler<HTMLDivElement> | ||
onCompositionUpdate | CompositionEventHandler<HTMLDivElement> | ||
onCompositionUpdateCapture | CompositionEventHandler<HTMLDivElement> | ||
onContextMenu | MouseEventHandler<HTMLDivElement> | ||
onContextMenuCapture | MouseEventHandler<HTMLDivElement> | ||
onCopy | ClipboardEventHandler<HTMLDivElement> | ||
onCopyCapture | ClipboardEventHandler<HTMLDivElement> | ||
onCut | ClipboardEventHandler<HTMLDivElement> | ||
onCutCapture | ClipboardEventHandler<HTMLDivElement> | ||
onDoubleClick | MouseEventHandler<HTMLDivElement> | ||
onDoubleClickCapture | MouseEventHandler<HTMLDivElement> | ||
onDrag | DragEventHandler<HTMLDivElement> | ||
onDragCapture | DragEventHandler<HTMLDivElement> | ||
onDragEnd | DragEventHandler<HTMLDivElement> | ||
onDragEndCapture | DragEventHandler<HTMLDivElement> | ||
onDragEnter | DragEventHandler<HTMLDivElement> | ||
onDragEnterCapture | DragEventHandler<HTMLDivElement> | ||
onDragExit | DragEventHandler<HTMLDivElement> | ||
onDragExitCapture | DragEventHandler<HTMLDivElement> | ||
onDragLeave | DragEventHandler<HTMLDivElement> | ||
onDragLeaveCapture | DragEventHandler<HTMLDivElement> | ||
onDragOver | DragEventHandler<HTMLDivElement> | ||
onDragOverCapture | DragEventHandler<HTMLDivElement> | ||
onDragStart | DragEventHandler<HTMLDivElement> | ||
onDragStartCapture | DragEventHandler<HTMLDivElement> | ||
onDrop | DragEventHandler<HTMLDivElement> | ||
onDropCapture | DragEventHandler<HTMLDivElement> | ||
onDurationChange | ReactEventHandler<HTMLDivElement> | ||
onDurationChangeCapture | ReactEventHandler<HTMLDivElement> | ||
onEmptied | ReactEventHandler<HTMLDivElement> | ||
onEmptiedCapture | ReactEventHandler<HTMLDivElement> | ||
onEncrypted | ReactEventHandler<HTMLDivElement> | ||
onEncryptedCapture | ReactEventHandler<HTMLDivElement> | ||
onEnded | ReactEventHandler<HTMLDivElement> | ||
onEndedCapture | ReactEventHandler<HTMLDivElement> | ||
onError | ReactEventHandler<HTMLDivElement> | ||
onErrorCapture | ReactEventHandler<HTMLDivElement> | ||
onFocus | FocusEventHandler<HTMLDivElement> | ||
onFocusCapture | FocusEventHandler<HTMLDivElement> | ||
onGotPointerCapture | PointerEventHandler<HTMLDivElement> | ||
onGotPointerCaptureCapture | PointerEventHandler<HTMLDivElement> | ||
onInput | FormEventHandler<HTMLDivElement> | ||
onInputCapture | FormEventHandler<HTMLDivElement> | ||
onInvalid | FormEventHandler<HTMLDivElement> | ||
onInvalidCapture | FormEventHandler<HTMLDivElement> | ||
onKeyDown | KeyboardEventHandler<HTMLDivElement> | ||
onKeyDownCapture | KeyboardEventHandler<HTMLDivElement> | ||
onKeyUp | KeyboardEventHandler<HTMLDivElement> | ||
onKeyUpCapture | KeyboardEventHandler<HTMLDivElement> | ||
onLoad | ReactEventHandler<HTMLDivElement> | ||
onLoadCapture | ReactEventHandler<HTMLDivElement> | ||
onLoadedData | ReactEventHandler<HTMLDivElement> | ||
onLoadedDataCapture | ReactEventHandler<HTMLDivElement> | ||
onLoadedMetadata | ReactEventHandler<HTMLDivElement> | ||
onLoadedMetadataCapture | ReactEventHandler<HTMLDivElement> | ||
onLoadStart | ReactEventHandler<HTMLDivElement> | ||
onLoadStartCapture | ReactEventHandler<HTMLDivElement> | ||
onLostPointerCapture | PointerEventHandler<HTMLDivElement> | ||
onLostPointerCaptureCapture | PointerEventHandler<HTMLDivElement> | ||
onMouseDown | MouseEventHandler<HTMLDivElement> | ||
onMouseDownCapture | MouseEventHandler<HTMLDivElement> | ||
onMouseEnter | MouseEventHandler<HTMLDivElement> | ||
onMouseLeave | MouseEventHandler<HTMLDivElement> | ||
onMouseMove | MouseEventHandler<HTMLDivElement> | ||
onMouseMoveCapture | MouseEventHandler<HTMLDivElement> | ||
onMouseOut | MouseEventHandler<HTMLDivElement> | ||
onMouseOutCapture | MouseEventHandler<HTMLDivElement> | ||
onMouseOver | MouseEventHandler<HTMLDivElement> | ||
onMouseOverCapture | MouseEventHandler<HTMLDivElement> | ||
onMouseUp | MouseEventHandler<HTMLDivElement> | ||
onMouseUpCapture | MouseEventHandler<HTMLDivElement> | ||
onPaste | ClipboardEventHandler<HTMLDivElement> | ||
onPasteCapture | ClipboardEventHandler<HTMLDivElement> | ||
onPause | ReactEventHandler<HTMLDivElement> | ||
onPauseCapture | ReactEventHandler<HTMLDivElement> | ||
onPlay | ReactEventHandler<HTMLDivElement> | ||
onPlayCapture | ReactEventHandler<HTMLDivElement> | ||
onPlaying | ReactEventHandler<HTMLDivElement> | ||
onPlayingCapture | ReactEventHandler<HTMLDivElement> | ||
onPointerCancel | PointerEventHandler<HTMLDivElement> | ||
onPointerCancelCapture | PointerEventHandler<HTMLDivElement> | ||
onPointerDown | PointerEventHandler<HTMLDivElement> | ||
onPointerDownCapture | PointerEventHandler<HTMLDivElement> | ||
onPointerEnter | PointerEventHandler<HTMLDivElement> | ||
onPointerEnterCapture | PointerEventHandler<HTMLDivElement> | ||
onPointerLeave | PointerEventHandler<HTMLDivElement> | ||
onPointerLeaveCapture | PointerEventHandler<HTMLDivElement> | ||
onPointerMove | PointerEventHandler<HTMLDivElement> | ||
onPointerMoveCapture | PointerEventHandler<HTMLDivElement> | ||
onPointerOut | PointerEventHandler<HTMLDivElement> | ||
onPointerOutCapture | PointerEventHandler<HTMLDivElement> | ||
onPointerOver | PointerEventHandler<HTMLDivElement> | ||
onPointerOverCapture | PointerEventHandler<HTMLDivElement> | ||
onPointerUp | PointerEventHandler<HTMLDivElement> | ||
onPointerUpCapture | PointerEventHandler<HTMLDivElement> | ||
onProgress | ReactEventHandler<HTMLDivElement> | ||
onProgressCapture | ReactEventHandler<HTMLDivElement> | ||
onRateChange | ReactEventHandler<HTMLDivElement> | ||
onRateChangeCapture | ReactEventHandler<HTMLDivElement> | ||
onReset | FormEventHandler<HTMLDivElement> | ||
onResetCapture | FormEventHandler<HTMLDivElement> | ||
onResize | ReactEventHandler<HTMLDivElement> | ||
onResizeCapture | ReactEventHandler<HTMLDivElement> | ||
onScroll | UIEventHandler<HTMLDivElement> | ||
onScrollCapture | UIEventHandler<HTMLDivElement> | ||
onSeeked | ReactEventHandler<HTMLDivElement> | ||
onSeekedCapture | ReactEventHandler<HTMLDivElement> | ||
onSeeking | ReactEventHandler<HTMLDivElement> | ||
onSeekingCapture | ReactEventHandler<HTMLDivElement> | ||
onSelect | ReactEventHandler<HTMLDivElement> | ||
onSelectCapture | ReactEventHandler<HTMLDivElement> | ||
onStalled | ReactEventHandler<HTMLDivElement> | ||
onStalledCapture | ReactEventHandler<HTMLDivElement> | ||
onSubmit | FormEventHandler<HTMLDivElement> | ||
onSubmitCapture | FormEventHandler<HTMLDivElement> | ||
onSuspend | ReactEventHandler<HTMLDivElement> | ||
onSuspendCapture | ReactEventHandler<HTMLDivElement> | ||
onTimeUpdate | ReactEventHandler<HTMLDivElement> | ||
onTimeUpdateCapture | ReactEventHandler<HTMLDivElement> | ||
onTouchCancel | TouchEventHandler<HTMLDivElement> | ||
onTouchCancelCapture | TouchEventHandler<HTMLDivElement> | ||
onTouchEnd | TouchEventHandler<HTMLDivElement> | ||
onTouchEndCapture | TouchEventHandler<HTMLDivElement> | ||
onTouchMove | TouchEventHandler<HTMLDivElement> | ||
onTouchMoveCapture | TouchEventHandler<HTMLDivElement> | ||
onTouchStart | TouchEventHandler<HTMLDivElement> | ||
onTouchStartCapture | TouchEventHandler<HTMLDivElement> | ||
onTransitionEnd | TransitionEventHandler<HTMLDivElement> | ||
onTransitionEndCapture | TransitionEventHandler<HTMLDivElement> | ||
onVolumeChange | ReactEventHandler<HTMLDivElement> | ||
onVolumeChangeCapture | ReactEventHandler<HTMLDivElement> | ||
onWaiting | ReactEventHandler<HTMLDivElement> | ||
onWaitingCapture | ReactEventHandler<HTMLDivElement> | ||
onWheel | WheelEventHandler<HTMLDivElement> | ||
onWheelCapture | WheelEventHandler<HTMLDivElement> | ||
overlayProps | ModalBaseOverlayProps | Props added to Overlay component, use configure opacity, background color, styles and other properties | |
padding | MantineNumberSize | Key of theme.spacing or any valid CSS value to set content, header and footer padding, 'md' by default | |
placeholder | string | ||
portalProps | Omit<PortalProps, "children" | "withinPortal" | "target"> | Props to pass down to the portal when withinPortal is true | |
prefix | string | ||
property | string | ||
radioGroup | string | ||
radius | MantineNumberSize | Key of theme.radius or any valid CSS value to set border-radius, theme.defaultRadius by default | |
resource | string | ||
results | number | ||
returnFocus | boolean | Determines whether focus should be returned to the last active element onClose is called, true by default | |
role | AriaRole | ||
scrollAreaComponent | ScrollAreaComponent | Scroll area component, ScrollArea.Autosize by default | |
security | string | ||
shadow | MantineShadow | Key of theme.shadows or any valid css box-shadow value, 'xl' by default | |
size | MantineNumberSize | Controls content width, 'md' by default | |
slot | string | ||
spellCheck | Booleanish | ||
style | CSSProperties | ||
styles | Styles<any> | ||
suppressContentEditableWarning | boolean | ||
suppressHydrationWarning | boolean | ||
tabIndex | number | ||
target | string | HTMLElement | Target element or selector where Portal should be rendered, by default new element is created and appended to the document.body | |
title | ReactNode | Modal title | |
transitionProps | Partial<Omit<TransitionProps, "mounted">> | Props added to Transition component that used to animate overlay and body, use to configure duration and animation type, { duration: 200, transition: 'pop' } by default | |
translate | "yes" | "no" | ||
trapFocus | boolean | Determines whether focus should be trapped, true by default | |
typeof | string | ||
unselectable | "off" | "on" | ||
unstyled | boolean | ||
variant | string | ||
vocab | string | ||
withCloseButton | boolean | Determines whether close button should be rendered, true by default | |
withinPortal | boolean | Determines whether component should be rendered inside Portal, true by default | |
withOverlay | boolean | Determines whether overlay should be rendered, true by default | |
xOffset | any | Left/right modal offset, 5vw by default | |
yOffset | any | Top/bottom modal offset, 5vh by default | |
zIndex | number | z-index CSS property of root element, 200 by default | |
"aria-dropeffect" deprecated | "link" | "none" | "copy" | "execute" | "move" | "popup" | in ARIA 1.1 Indicates what functions can be performed when a dragged object is released on the drop target. | |
"aria-grabbed" deprecated | Booleanish | in ARIA 1.1 Indicates an element's "grabbed" state in a drag-and-drop operation. | |
onKeyPress deprecated | KeyboardEventHandler<HTMLDivElement> | ||
onKeyPressCapture deprecated | KeyboardEventHandler<HTMLDivElement> |
No guidelines exist for Modal yet.