@igloo-ui/modal
TypeScript icon, indicating that this package has built-in type declarations

1.9.0 • Public • Published

Modal

The Modal is an interface component positioned over the page content to emphasize new elements. It blocks standard navigation and requires interaction from the user to be dismissed.

Installation

To install @igloo-ui/modal in your project, you will need to run the following command using npm:

npm install @igloo-ui/modal

If you prefer Yarn, use the following command instead:

yarn add @igloo-ui/modal

Usage

Then to use the component in your code just import it!

import Modal from '@igloo-ui/modal';
import Button from '@igloo-ui/button';

const [show, setShow] = useState(false);

<Button appearance="secondary" onClick={() => setShow(true)}>
  open modal
</Button>;

<Modal
  title={`Modal title`}
  isDismissable
  isClosable
  isOpen={show}
  closeBtnAriaLabel={`Close`}
  onClose={() => setShow(false)}
>
  Modal content
</Modal>;

Troubleshooting

When a Dialog opens above a Modal

In this case, when you close the Dialog, the Modal closes automatically. Here is a workaround to remedy this.

To solve the problem, set the isDismissable property of the Modal to false when the Dialog component is up and then return to true when it closes.

Readme

Keywords

none

Package Sidebar

Install

npm i @igloo-ui/modal

Weekly Downloads

6

Version

1.9.0

License

Apache-2.0

Unpacked Size

1.6 MB

Total Files

8

Last publish

Collaborators

  • infra.admin
  • franckgaudin