@suyoungj/react-simple-modal-ts

A simple & customizable modal component for React with TypeScript support.

Installation

# npm
npm i @suyoungj/react-simple-modal-ts

# yarn
yarn add @suyoungj/react-simple-modal-ts

Imports

import { Modal, useModal } from '@suyoungj/react-simple-modal-ts';

Usage

The useModal hook provides an easy way to manage the state of the modal. It returns an object with:

• isModalOpen: a boolean that indicates whether the modal is currently open.
• openModal: a function that opens the modal.
• closeModal: a function that closes the modal.

Props

The Modal component accepts the following props:

• isModalOpen (required): a boolean that indicates whether the modal is currently open.
• onCloseModal (required): a function that is called when the modal is closed. This function should set the isModalOpen state to false.

function ModalExample() {
  const { isModalOpen, openModal, closeModal } = useModal();

  return (
    <>
      <button onClick={openModal}>Open Modal</button>
      <Modal isModalOpen={isModalOpen} onCloseModal={closeModal}>
        {/* Modal Content Here */}
        Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor
        incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis
        nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
        Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore
        eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident,
        sunt in culpa qui officia deserunt mollit anim id est laborum.
      </Modal>
    </>
  );
}

export default ModalExample;

Example

Features

• Closed by clicking the backdrop
• Closed when the Esc key is pressed

Dependencies

• React (^17.0.2 or higher)
• TypeScript (^4.3.5 or higher)
• styled-components (^5.3.0 or higher)