Interface IDialogProps
Hierarchy
-
IDialogProps
- IDialogProps
Index
Properties
- aria
Described ById - aria
Labelled ById - buttons
- children
- class
Name - close
Button Aria Label - component
Ref - container
Class Name - content
Class Name - dialog
Content Props - disable
Restore Focus - element
ToFocus OnDismiss - first
Focusable Selector - force
Focus Inside Trap - hidden
- ignore
External Focusing - is
Blocking - is
Clickable Outside Focus Trap - is
Dark Overlay - is
Open - key
- max
Width - min
Width - modal
Props - ref
- responsive
Mode - styles
- sub
Text - theme
- title
- top
Buttons Props - type
Methods
Properties
Optional ariaDescribedById
Optional ariaLabelledById
Optional id for aria-LabelledBy
Optional buttons
Optional children
Optional className
Optional class name to be added to the root class
Optional closeButtonAriaLabel
Aria label on close button.
Optional componentRef
Optional containerClassName
Optional override for container class
Optional contentClassName
Optional override content class
Optional dialogContentProps
Props to be passed through to Dialog Content
Optional disableRestoreFocus
If false (the default), the control's FocusTrapZone will restore focus to the element which activated it once the trap zone is unmounted or disabled. Set to true to disable this behavior.
Optional elementToFocusOnDismiss
Sets the element to focus on when exiting the control's FocusTrapZone.
Optional firstFocusableSelector
Class name (not actual selector) for first focusable item. Do not append a dot.
Optional forceFocusInsideTrap
Whether control should force focus inside its focus trap zone.
Optional hidden
Whether the dialog is hidden.
Optional ignoreExternalFocusing
Optional isBlocking
Whether the dialog can be light dismissed by clicking outside the dialog (on the overlay).
Optional isClickableOutsideFocusTrap
Whether this control will allow clicks outside its FocusTrapZone.
Optional isDarkOverlay
Whether the overlay is dark themed.
Optional isOpen
Whether the dialog is displayed.
Optional key
Optional maxWidth
Sets the maximum width for the dialog. It limits the width property to be larger than the value specified in max-width.
Optional minWidth
Sets the minimum width of the dialog. It limits the width property to be not smaller than the value specified in min-width.
Optional modalProps
Props to be passed through to Modal
Optional ref
Optional responsiveMode
Optional styles
Call to provide customized styling that will layer on top of the variant rules
Optional subText
The subtext to display in the dialog.
Optional theme
Theme provided by HOC.
Optional title
Optional topButtonsProps
Other top buttons that will show up next to the close button
Optional type
The type of Dialog to display.
Methods
Optional onDismiss
-
A callback function for when the Dialog is dismissed from the close button or light dismiss. Can also be specified separately in content and modal.
Parameters
-
Optional ev: MouseEvent<HTMLButtonElement, MouseEvent>
Returns any
-
Optional onDismissed
-
A callback function which is called after the Dialog is dismissed and the animation is complete.
Returns any
Optional onLayerDidMount
-
A callback function for when the Dialog content is mounted on the overlay layer
Returns void
Optional onLayerMounted
-
Deprecated at 0.81.2.
Returns void
Generated using TypeDoc
Optional id for aria-DescribedBy
Pass through via
modalProps.subtitleAriaIdinstead.