No Preview

Sorry, but you either have no stories or none are selected somehow.

If the problem persists, check the browser console, or the terminal you've run Storybook from.

The component failed to render properly, likely due to a configuration issue in Storybook. Here are some common causes and how you can address them:

  1. Missing Context/Providers: You can use decorators to supply specific contexts or providers, which are sometimes necessary for components to render correctly. For detailed instructions on using decorators, please visit the Decorators documentation.
  2. Misconfigured Webpack or Vite: Verify that Storybook picks up all necessary settings for loaders, plugins, and other relevant parameters. You can find step-by-step guides for configuring Webpack or Vite with Storybook.
  3. Missing Environment Variables: Your Storybook may require specific environment variables to function as intended. You can set up custom environment variables as outlined in the Environment Variables documentation.

Modal

Generic Modal component.

Example usage:

<Modal title="title" isOpen={true}>
  <div>Some body</div>
  <Modal.ButtonRow>
    <Button variant="secondary" fill="outline">
      Cancel
    </Button>
    <Button>Save</Button>
  </Modal.ButtonRow>
</Modal>

For buttons at the bottom of the modal you should always use:

  • Modal.ButtonRow - this makes sure the Buttons are right aligned
  • If you have a Cancel button use fill="outline" and variant="secondary" and place it on the left side of any other button.
NameDescriptionDefault
icon
"play""google""microsoft""github""gitlab""okta""discord""hipchat"
Deprecated: no longer used
-
iconTooltip
string
Deprecated: no longer used
-
title*
Title for the modal or custom header element
stringElement
-
className
string
-
contentClassName
string
-
closeOnEscape
boolean
-
closeOnBackdropClick
boolean
-
trapFocus
boolean
-
isOpen
boolean
-
onDismiss
(() => void)
-
onClickBackdrop
If not set will call onDismiss if that is set.
(() => void)
-

ModalTabsHeader

Custom header element with tabs

NameDescriptionDefault
icon*
"play""google""microsoft""github""gitlab""okta""discord""hipchat"
-
title*
string
-
tabs*
ModalTab[]
-
activeTab*
string
-
onChangeTab*
(tab: ModalTab) => void
-