# react-modal-typescript-custom

> Library to easily display and customize a modal

Latest version **1.0.0** (published 2022-10-10) · 0 weekly downloads

## Install

```sh
npm install react-modal-typescript-custom
pnpm add react-modal-typescript-custom
yarn add react-modal-typescript-custom
bun add react-modal-typescript-custom
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2022-10-10 |
| First published | 2022-10-10 |
| Weekly downloads | 0 |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 12.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Laetitia Hars |
| Maintainers | laetitiah |
| Keywords | modal, react-modal, react-modal-typescript-custom, dialog, typescript |

## Links

- npm: https://www.npmjs.com/package/react-modal-typescript-custom
- Repository: https://github.com/LaetitiaH/LaetitiaHars_14_08122020_2
- Homepage: https://github.com/LaetitiaH/LaetitiaHars_14_08122020_2#readme
- Issues: https://github.com/LaetitiaH/LaetitiaHars_14_08122020_2/issues
- npm.io page: https://npm.io/package/react-modal-typescript-custom

## Alternatives

- [react-native-root-siblings](https://npm.io/package/react-native-root-siblings.md) — 102.9K weekly downloads
- [@praxisui/dialog](https://npm.io/package/@praxisui/dialog.md) — 2.0K weekly downloads
- [easy-toggle-state](https://npm.io/package/easy-toggle-state.md) — 350 weekly downloads
- [ngx-lightbox-evp](https://npm.io/package/ngx-lightbox-evp.md) — 19 weekly downloads
- [react-native-modal-translucent-axton](https://npm.io/package/react-native-modal-translucent-axton.md) — 4 weekly downloads

## Recent versions

- 1.0.0 (latest) — 2022-10-10

## README

[![forthebadge](https://forthebadge.com/images/badges/made-with-javascript.svg)](https://forthebadge.com) [![forthebadge](https://forthebadge.com/images/badges/uses-css.svg)](https://forthebadge.com)

# React-modal-typescript-custom

A library to easily display and customize a modal.

## Technologies
- JS
- Sass
- React

## Authors

React-modal-typescript-custom is developed by Laetitia Hars

## Version

Version 0.1.0

## Installation

To install, you can use [npm](https://www.npmjs.com/)

```
$ npm install --save react-modal-typescript-custom
```

## Documentation

### General Usage

The only prop required is ```isShowing```, which is used to indicate whether the pop-up should be opened.
The following example describes how to open and close a modal, as well as all the possible options.

```
import Modal from 'react-modal-typescript-custom';
import "react-modal-typescript-custom/dist/index.css";

    <Modal
      isShowing={false}, /* Open modal if true */
      
      onRequestClose={afterCloseFunction}, /* Function to be executed when the modal is closed */
      
      title={null}, /* Text content for the modal title */ (null means no title)
      
      clickClose={true}, /* Allows the user to close the modal by clicking the overlay */
      
      escapeClose={true}, /* Allows the user to close the modal by pressing `ESC` */
      
      showClose={true}, /* Shows a (X) icon button in the top-right corner */
      
      closeText={"Close"}, /* Text content for the close <button> */
      
      closeClass={""}, /* Add additional class(es) to the close <button> tag */
      
      modalClass={""}, /* CSS class added to the element being displayed in the modal */
      
      overlayClass={""}, /* CSS class added to the overlay */
      
      fadeDuration={250}, /* Number of milliseconds the fade transition takes (0 means no transition) */
      >
        <div>Modal content</div>
      </Modal>
```

---
_Source: https://npm.io/package/react-modal-typescript-custom · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._