Skip to content
Home

Modal

Info
Demos
Properties
Events

Import

import { Modal } from '@dnb/eufemia'

Description

Modal is the root component for Drawer and Dialog. If one of these satisfy your needs, you want to use those rather than directly using Modal. Using the Modal, it's possible to implement other modal variants than we provide as of now(Drawer and Dialog).

NB! Modal dialogs interrupt users and demand an action. They are appropriate when the user’s attention needs to be directed toward important information.

Behavior

The modal can be triggered from either a button or by using the open_state property. Triggering a modal will activate the opaque overlay and display the contents.

Help button

As the Modal is very often used in combination with other components and often as an enhancement of contextual content, it comes with a trigger button (HelpButton) with a question mark icon by default. You can for sure disable that behavior by using omitTriggerButton={true}.

You can also use the broadly available suffix property, like so:

Code Editor
<Input
  label="Input"
  placeholder="Placeholder ..."
  suffix={<HelpButton>Help text</HelpButton>}
/>

Accessibility

In order to make modals accessible, a lot of things are considered.

Entering a Modal (all variants) will:

  1. Set focus on the heading or close button.
  2. Enable escape key listener.
  3. Invalidate every DOM element outside of the Modal / Drawer, so they are not accessible to keyboard and screen reader users. For doing that, there is a helper function to be used in your application as well.
  4. Disable the body scroll possibility.
  5. Make the Modal / Drawer scrollable if needed.
  6. Dim the body / background with an overlay.

Structure and content

Typically an opaque cover over the main content (fullscreen) and a small centered box containing information and interactive elements (buttons, forms etc.)

What is it

Modal dialogs appear on top of the main content changing the mode of the system into a special mode requiring user interaction. The main content is disabled until the user interacts with the modal dialog.

Disadvantages of Modal

  1. They require immediate attention.
  2. They interrupt users.
  3. They cause users to forget what they were doing.
  4. They add extra goals - reading, interacting, and closing the Modal.
  5. They block the content in the background.

Guidelines

  1. Use for important warnings as a way to prevent or correct critical errors.
  2. Do not use for unessential information that is not related to the user's current workflow.
  3. Use for requesting the user to enter information critical to the current process.

Nested modals

While it is possible to nest a Modal within another Modal, you as a developer have to ensure the Browsers back-button (alongside the URL path), does take care of the nested Modal situation. Because a user should still be able to use the back button as expected and return to the last visited "page".

Root Element

NB: If the wrapper is not set manually, a wrapper is inserted automatically as a child node to the body.

To make sure the HTML structure is decoupled from all the page content, you can optionally define a wrapper div like <div class="dnb-modal-root" />.

Just place this as a sibling of your app root HTML element. This ensures that we always can stack the modal content above the App Content.

<body>
  <div id="app" />
  <div id="dnb-modal-root" />
</body>

Z-index

The Modal component is using 3000 as the z-index.

:root {
  --modal-z-index: 3000;
}

data-dnb-modal-active

When a Modal / Drawer is open, it will set an HTML attribute on the main HTML Element called data-dnb-modal-active. The attribute value will be the ID of the current Modal / Drawer.

This can be used to handle z-index issues from within CSS only:

html[data-dnb-modal-active='MODAL-ID'] {
  /* Your css */
}

Demos

The following examples are to demonstrate the functionality of Modal. Please go to Drawer demos or Dialog demos for complete component demos.

Example

Code Editor
<Modal>
  <ExampleCard>
    <P>This is a Modal that you can use to make custom variations</P>
  </ExampleCard>
</Modal>

Open Modal by the state only

Use a custom trigger button and state handling by setting omitTriggerButton to Modal.

Code Editor
const Component = () => {
  const [modalIsActive, setModalState] = React.useState(false)
  return (
    <>
      <Button
        id="custom-triggerer"
        text="Custom trigger Button"
        on_click={() => setModalState((s) => !s)}
      />
      <Modal
        title="Modal Title"
        omit_trigger_button
        open_state={modalIsActive}
        labelled_by="custom-triggerer"
        on_close={() => setModalState(false)}
      >
        <ExampleCard>
          <P>This Modal was opened by a custom trigger button.</P>
        </ExampleCard>
      </Modal>
    </>
  )
}
render(<Component />)

Close Modal by handlers

Use the close_modal prop to set another close handler, like a timeout for when the modal should close.

Code Editor
<Modal
  title="Auto close"
  triggerAttributes={{
    text: 'Click me',
  }}
  align_content="center"
  max_width="40rem"
  close_modal={(close) => {
    const timeout = setTimeout(close, 3e3)
    return () => clearTimeout(timeout)
  }}
>
  <ExampleCard>
    <P>This Modal will close in 3 seconds.</P>
  </ExampleCard>
</Modal>