MarketingModal
MarketingModal
is similar to the alert modal, providing friendly messaging to our users to encourage greater engagement than the simpler confirmation dialogs. They should enable platform understanding, highlight opportunities, and support workflow engagement.
The MarketingModal
is a preconfigured ModalDialog
that accepts an image and center aligns buttons.
Basic Usage
Any Paragon component or export may be added to the code example.
Theme Variables (SCSS)#
$modal-inner-padding: 1.5rem !default;$modal-inner-padding-bottom: .7rem !default;$modal-footer-margin-between: .5rem !default;$modal-dialog-margin: 1.5rem !default;$modal-dialog-margin-y-sm-up: 1.75rem !default;$modal-title-line-height: $line-height-base !default;$modal-content-color: null !default;$modal-content-bg: $white !default;$modal-content-border-color: rgba($black, .2) !default;$modal-content-border-width: 0 !default;$modal-content-border-radius: $border-radius-lg !default;$modal-content-inner-border-radius: subtract($modal-content-border-radius, $modal-content-border-width) !default;$modal-content-box-shadow-xs: 0 .25rem .5rem rgba($black, .5) !default;$modal-content-box-shadow-sm-up: 0 10px 20px rgba($black, .15), 0 8px 20px rgba($black, .15) !default;$modal-backdrop-bg: $black !default;$modal-backdrop-opacity: .5 !default;$modal-header-border-color: $border-color !default;$modal-footer-border-color: $modal-header-border-color !default;$modal-header-border-width: $modal-content-border-width !default;$modal-footer-border-width: $modal-header-border-width !default;$modal-header-padding-y: 1rem !default;$modal-header-padding-x: 1.5rem !default;$modal-close-container-top: .625rem !default;$modal-header-padding: $modal-header-padding-y $modal-header-padding-x !default;$modal-footer-padding-y: 1rem !default;$modal-footer-padding-x: 1.5rem !default;$modal-footer-padding: $modal-footer-padding-y $modal-footer-padding-x !default;$modal-xl: 1140px !default;$modal-lg: 800px !default;$modal-md: 500px !default;$modal-sm: 400px !default;$modal-fade-transform: translate(0, -50px) !default;$modal-show-transform: none !default;$modal-transition: transform .3s ease-out !default;$modal-scale-transform: scale(1.02) !default;
Props API#
- children
node
RequiredSpecifies the content of the modal
- title
string
RequiredTitle of the modal
- 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
DefaulttrueThe close 'x' icon button in the top right corner
- onClose
requiredWhenNot(PropTypes.func, 'isBlocking')
Default() => {}Callback function for when the modal is dismissed
- size
enum
'sm' | 'md' | 'lg' | 'xl' | 'fullscreen'Default'md'Size of the modal window
- closeLabel
string
Default'Close'Specifies the
aria-label
attribute for the close button - className
string
Specifies class name to append to the base element
- isFullscreenScroll
bool
DefaulttrueDetermines 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 nodal
- heroIsDark
bool
DefaulttrueEnables dark theme for the modal
- heroNode
node
DefaultnullSpecifies what should be displayed in the header of the modal
- beforeBodyNode
node
DefaultnullSpecifies what should be displayed before the body block
- afterBodyNode
node
DefaultnullSpecifies what should be displayed after the body block
- children
node
RequiredSpecifies the content of the dialog
- title
string
RequiredThe aria-label of the dialog
- onClose
func
RequiredA callback to close the modal dialog
- isOpen
bool
DefaultfalseIs the modal dialog open or closed
- hasCloseButton
bool
DefaulttrueThe close 'x' icon button in the top right of the dialog box
- size
enum
'sm' | 'md' | 'lg' | 'xl' | 'fullscreen'Default'md'Sizes determine the maximum width of the dialog box
- variant
enum
'default' | 'warning' | 'danger' | 'success' | 'dark'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. - isFullscreenOnMobile
bool
DefaultfalseTo show full screen view on mobile screens
- isBlocking
bool
DefaultfalsePrevent clicking on the backdrop or pressing Esc to close the modal
- zIndex
number
Specifies the z-index of the modal
- isOverflowVisible
bool
DefaulttrueSpecifies whether overflow is visible in the modal
Usage Insights#
MarketingModal
Project Name | Paragon Version | Instance Count | |
---|---|---|---|
frontend-app-learner-dashboard | 22.8.1 | 1 | |
frontend-app-learner-portal-enterprise | 21.13.1 | 1 | |
frontend-app-learning | 22.8.1 | 1 |
ModalDialog
Project Name | Paragon Version | Instance Count | |
---|---|---|---|
frontend-app-account | 22.0.0 | 4 | |
frontend-app-admin-portal | 21.13.1 | 22 | |
frontend-app-authn | 22.8.1 | 2 | |
frontend-app-communications | 22.7.0 | 1 | |
frontend-app-course-authoring | 22.8.1 | 19 | |
ora_settings | 22.8.1 | 1 | |
proctoring | 22.8.1 | 1 | |
xpert_unit_summary | 22.8.1 | 1 | |
frontend-app-discussions | 22.7.0 | 2 | |
frontend-app-enterprise-public-catalog | 21.13.1 | 2 | |
frontend-app-gradebook | 22.8.1 | 1 | |
frontend-app-learner-dashboard | 22.8.1 | 5 | |
frontend-app-learner-portal-enterprise | 21.13.1 | 3 | |
frontend-app-learner-record | 22.8.1 | 1 | |
frontend-app-learning | 22.8.1 | 4 | |
frontend-app-library-authoring | 21.11.3 | 3 | |
frontend-app-payment | 22.8.1 | 2 | |
frontend-app-publisher | 21.13.1 | 1 | |
frontend-app-support-tools | 21.13.1 | 16 | |
frontend-lib-special-exams | 22.7.0 | 1 | |
prospectus | 20.46.2 | 3 |