AlertModal
Alert Dialogs are used to block the user from moving forward in a particular workflow with a quick message that requires agreement before the action or next step can be taken. An example is providing a warning that settings may not be updated if the user has not chosen to save their changes.
This is the alert style ModalDialog
composition. AlertModal
passes all of its props through to an underlying ModalDialog
component providing some limited customization. If you have unique needs, use the ModalDialog
compound component family directly.
Basic usage
Any Paragon component or export may be added to the code example.
Variants
Any Paragon component or export may be added to the code example.
Any Paragon component or export may be added to the code example.
Any Paragon component or export may be added to the code example.
Theme Variables#
CSS Variable | Computed Value |
---|---|
| |
| |
| |
| |
| |
Props API#
- children
node
Required - title
string
RequiredThe aria-label of the dialog
- isOpen
bool
DefaultfalseIs the modal dialog open or closed
- isBlocking
bool
DefaultfalsePrevent clicking on the backdrop or pressing Esc to close the modal
- hasCloseButton
bool
DefaultfalseSpecifies whether the dialog box should contain 'x' icon button in the top right
- onClose
requiredWhenNot(PropTypes.func, 'isBlocking')
Default() => {}A callback to close the modal dialog
- size
enum
'sm' | 'md' | 'lg' | 'xl' | 'fullscreen'Default'md'Sizes determine the maximum width of the dialog box
- variant
enum
'default' | 'warning' | 'danger' | 'success'Default'default'The visual style of the dialog box
- closeLabel
string
Default'Close'The label supplied to the close icon button if one is rendered
- className
string
Specifies class name to append to the base element
- isFullscreenScroll
bool
DefaultfalseDetermines where a scrollbar should appear if a modal is too large for the viewport. When false, the ModalDialog.Body receives a scrollbar, when true the browser window itself receives the scrollbar.
- footerNode
node
DefaultnullSpecifies what should be displayed in the footer of the dialog box
- icon
elementType
Icon that will be shown in the header of modal
- children
React.ReactNode
RequiredSpecifies the content of the dialog
- title
string
RequiredThe aria-label of the dialog
- onClose
() => void
RequiredA callback to close the modal dialog, e.g. when Escape is pressed
- isOpen
boolean
DefaultfalseIs the modal dialog open or closed?
- hasCloseButton
boolean
DefaulttrueThe close 'x' icon button in the top right of the dialog box
- size
'sm'
|'md'
|'lg'
|'xl'
|'fullscreen'
Default'md'Size determines the maximum width of the dialog box
- variant
'default'
|'warning'
|'danger'
|'success'
|'dark'
Default'default'The visual style of the dialog box
- closeLabel
string
The label supplied to the close icon button if one is rendered
- className
string
Specifies class name to append to the base element
- isFullscreenScroll
boolean
DefaultfalseDetermines where a scrollbar should appear if a modal is too large for the viewport. When false, the
ModalDialog
. Body receives a scrollbar, when true the browser window itself receives the scrollbar. - isFullscreenOnMobile
boolean
DefaultfalseTo show full screen view on mobile screens
- isBlocking
boolean
DefaultfalsePrevent clicking on the backdrop or pressing Esc to close the modal
- zIndex
number
Specifies the z-index of the modal
- isOverflowVisible
boolean
RequiredSpecifies whether overflow content inside the modal should be visible.
true
- content that exceeds the modal boundaries will remain visible outside the modal's main viewport, rather than being clipped or hidden.false
- any overflow content will be clipped to fit within the modal's dimensions.
Usage Insights#
AlertModal
Project Name | Paragon Version | Instance Count | |
---|---|---|---|
frontend-app-account | 23.14.1 | 1 | |
frontend-app-admin-portal | 22.18.0 | 13 | |
frontend-app-communications | 23.12.2 | 1 | |
frontend-app-course-authoring | 23.14.1 | 10 | |
frontend-app-discussions | 23.4.5 | 1 | |
frontend-app-ecommerce | 20.46.3 | 1 | |
frontend-app-learner-portal-enterprise | 22.17.0 | 1 | |
frontend-app-learning | 23.4.5 | 1 | |
frontend-app-support-tools | 23.4.2 | 1 |
ModalDialog
Project Name | Paragon Version | Instance Count | |
---|---|---|---|
frontend-app-account | 23.14.1 | 4 | |
frontend-app-admin-portal | 22.18.0 | 29 | |
frontend-app-communications | 23.12.2 | 1 | |
frontend-app-course-authoring | 23.14.1 | 19 | |
ora_settings | 23.14.1 | 1 | |
proctoring | 23.14.1 | 1 | |
frontend-app-discussions | 23.4.5 | 2 | |
frontend-app-enterprise-public-catalog | 22.17.0 | 2 | |
frontend-app-gradebook | 23.4.5 | 1 | |
frontend-app-discussions | 23.14.1 | 17 | |
frontend-app-learner-portal-enterprise | 22.17.0 | 3 | |
frontend-app-learner-record | 23.14.2 | 1 | |
frontend-app-gradebook | 23.4.5 | 2 | |
frontend-app-library-authoring | 21.11.3 | 3 | |
frontend-app-support-tools | 23.4.2 | 16 | |
frontend-lib-special-exams | 23.4.2 | 1 |