https://github.com/dotmind/react-modals
React Modals is a tool to quickly generate modals
https://github.com/dotmind/react-modals
modal reactjs typescript
Last synced: about 1 year ago
JSON representation
React Modals is a tool to quickly generate modals
- Host: GitHub
- URL: https://github.com/dotmind/react-modals
- Owner: dotmind
- License: mit
- Created: 2021-04-15T09:40:31.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2023-01-20T14:22:54.000Z (over 3 years ago)
- Last Synced: 2025-03-29T17:01:23.583Z (about 1 year ago)
- Topics: modal, reactjs, typescript
- Language: TypeScript
- Homepage:
- Size: 1.6 MB
- Stars: 8
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
@dotmind/react-modals
React Modals is a tool to quickly generate modals
## Menu
- [Menu](#menu)
- [✋ Disclaimer](#-disclaimer)
- [💻 Installation](#-installation)
- [👷♂️ How it's work](#️-how-its-work)
- [Modal usage](#modal-usage)
- [⚡️ Contributing](#️-contributing)
- [🔐 License](#-license)
## ✋ Disclaimer
Create quickly and easily modals for React. Builded by dotmind.io
If you’re familiar with the basics of React, you will know that because of its structure you can face some serious CSS issues when you need to show a modal.
With this package you can :
- clip your modal on any page
- say goodbye to CSS issues
- saving time and simply customize
Let's code 🚀.
If you use React < 18, please use version 2.0.2 ([React 18 changelog](https://reactjs.org/blog/2022/03/29/react-v18.html#new-client-and-server-rendering-apis))
Version 2.0.3+ require React 18+
## 💻 Installation
```bash
yarn add @dotmind/react-modals
```
or
```bash
npm i @dotmind/react-modals
```
## 👷♂️ How it's work
### Modal usage
```javascript
import React, { useCallback, useState } from 'react';
import Modal from '@dotmind/react-modals';
const App: React.FC = () => {
const [modalOpen, setModalOpen] = useState(false);
const handleChangeModal = useCallback(() => {
setModalOpen((prevState) => !prevState);
}, [setModalOpen]);
return (
Test react modal
Click me !
This is modal content
You can put your html here, have fun !
);
};
```
| props | description | required | type |
| -------------------- | -------------------------------- | -------- | ---------------------- |
| modalOpen | Modal state | true | boolean |
| onClose | Close modal function | true | () => void |
| children | Modal content | true | ReactNode |
| containerZIndex | Add custom z-index to container | false | number |
| closeButtonElement | Modify close button element | false | ReactElement or string |
| closeButtonClassName | Add custom class on close button | false | string |
| containerClassName | Add custom class on container | false | string |
| contentClassName | Add custom class on content | false | string |
| closeOnClickOutside | Close modal on click outside | false | boolean |
| showCloseButton | Hide or show button button | false | boolean |
| withShadow | Add default box shadow | false | boolean |
## ⚡️ Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Please make sure to update tests as appropriate.
## 🔐 License
[MIT](https://choosealicense.com/licenses/mit/)