StandardModal

Edit this page Leave feedback

The standard ModalDialog composition. StandardModal 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

Show editable code example

Any Paragon component or export may be added to the code example.

() => {
  const [isOpen, open, close] = useToggle(false);
  return (
    <>
      <Button variant="outline-primary" onClick={open}>Open standard modal</Button>

      <StandardModal
        title="This is a standard modal dialog"
        isOpen={isOpen}
        onClose={close}
        footerNode={(
          <ActionRow>
            <p className="small">
              <Hyperlink href="#">Get help</Hyperlink>
            </p>
            <ActionRow.Spacer />
            <Button variant="tertiary" onClick={close}>Cancel</Button>
            <Button>Submit</Button>
          </ActionRow>
        )}
      >
        <p>
          I'm baby palo santo ugh celiac fashion axe. La croix lo-fi venmo whatever. Beard man braid migas single-origin coffee forage ramps. Tumeric messenger bag bicycle rights wayfarers, try-hard cronut blue bottle health goth. Sriracha tumblr cardigan, cloud bread succulents tumeric copper mug marfa semiotics woke next level organic roof party +1 try-hard.
        </p>
      </StandardModal>
    </>
  )
}

() => {
  const [isOpen, open, close] = useToggle(false);
  return (
    <>
      <Button variant="outline-primary" onClick={open}>Open standard modal</Button>

      <StandardModal
        title="This is a standard modal dialog"
        isOpen={isOpen}
        onClose={close}
        footerNode={(
          <ActionRow>
            <p className="small">
              <Hyperlink href="#">Get help</Hyperlink>
            </p>
            <ActionRow.Spacer />
            <Button variant="tertiary" onClick={close}>Cancel</Button>
            <Button>Submit</Button>
          </ActionRow>
        )}
      >
        <p>
          I'm baby palo santo ugh celiac fashion axe. La croix lo-fi venmo whatever. Beard man braid migas single-origin coffee forage ramps. Tumeric messenger bag bicycle rights wayfarers, try-hard cronut blue bottle health goth. Sriracha tumblr cardigan, cloud bread succulents tumeric copper mug marfa semiotics woke next level organic roof party +1 try-hard.
        </p>
      </StandardModal>
    </>
  )
}

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#

StandardModal Props API

children node Required
Specifies the content of the Modal
title string Required
The title for the Modal
onClose func Required
Optional callback function for when the modal it dismissed.
isOpen bool
Is the modal open or closed
Defaultfalse
hasCloseButton bool
The close 'x' icon button in the top right corner
Defaulttrue
size enum'sm' | 'md' | 'lg' | 'xl' | 'fullscreen'
The modal size
Default'md'
variant enum'default' | 'warning' | 'danger' | 'success' | 'dark'
The modal style variant to use
Default'default'
closeLabel string
Specifies the aria-label attribute for the close button
Default'Close'
className string
A class name to append to the modal
isFullscreenScroll bool
Determines 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.
Defaultfalse
footerNode node
Specifies what should be displayed in the footer of the nodal
Defaultnull
beforeBodyNode node
Specifies what should be displayed before the body block
Defaultnull
afterBodyNode node
Specifies what should be displayed after the body block
Defaultnull

ModalDialog Props API

children node Required
Specifies the content of the dialog
title string Required
The aria-label of the dialog
onClose func Required
A callback to close the modal dialog
isOpen bool
Is the modal dialog open or closed
Defaultfalse
hasCloseButton bool
The close 'x' icon button in the top right of the dialog box
Defaulttrue
size enum'sm' | 'md' | 'lg' | 'xl' | 'fullscreen'
Sizes determine the maximum width of the dialog box
Default'md'
variant enum'default' | 'warning' | 'danger' | 'success' | 'dark'
The visual style of the dialog box
Default'default'
closeLabel string
The label supplied to the close icon button if one is rendered
Default'Close'
className string
Specifies class name to append to the base element
isFullscreenScroll bool
Determines 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.
Defaultfalse
isFullscreenOnMobile bool
To show full screen view on mobile screens
Defaultfalse
isBlocking bool
Prevent clicking on the backdrop or pressing Esc to close the modal
Defaultfalse
zIndex number
Specifies the z-index of the modal
isOverflowVisible bool
Specifies whether overflow is visible in the modal
Defaulttrue

Usage Insights#

ModalDialog

Project Name	Paragon Version	Instance Count
frontend-app-account	20.46.3	4
frontend-app-admin-portal	20.46.3	15
frontend-app-authn	20.46.2	2
frontend-app-communications	20.46.2	1
frontend-app-course-authoring	21.5.6	12
frontend-app-discussions	20.46.3	2
frontend-app-enterprise-public-catalog	20.46.3	2
frontend-app-gradebook	20.45.0	1
frontend-app-learner-dashboard	20.46.2	6
frontend-app-learner-portal-enterprise	20.45.4	1
frontend-app-learner-record	20.46.3	1
frontend-app-learning	20.46.0	4
frontend-app-library-authoring	21.5.6	3
frontend-app-payment	20.46.2	2
frontend-app-publisher	20.46.3	1
frontend-app-support-tools	20.46.0	15
frontend-lib-content-components	21.5.6	2
frontend-lib-special-exams	20.44.0	1
prospectus	20.46.2	3

StandardModal

Project Name	Paragon Version	Instance Count
frontend-app-learner-portal-enterprise	20.45.4	2
frontend-app-learner-record	20.46.3	2
frontend-app-learning	20.46.0	2

Edit this page Leave feedback

Paragon Design System

Theme

StandardModal

Basic usage

Theme Variables (SCSS)#

Props API#

Usage Insights#

ModalDialog

StandardModal

All components (A-Z)

Theme

StandardModal

Basic usage#

Theme Variables (SCSS)#

Props API#

Usage Insights#

ModalDialog

StandardModal

All components (A-Z)

Basic usage