Package Exports
- @dotmind/react-modals
- @dotmind/react-modals/dist/index.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@dotmind/react-modals) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme

@dotmind/react-modals
React Modals is a tool to quickly generate modals
Menu
✋ Disclaimer
This package helps to create custom modals in a blaze speed 🚀.
You need react >= 17.0.
💻 Installation
yarn add @dotmind/react-modals
or
npm i @dotmind/react-modals
👷♂️ How it's work
Modal usage
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 (
<div>
<h1>Test react modal</h1>
<button onClick={handleChangeModal}>Click me !</button>
<Modal
modalOpen={modalOpen}
onClose={handleChangeModal}
containerZIndex={9999}
>
<h1>This is modal content</h1>
<p>You can put your html here, have fun !</p>
</Modal>
</div>
);
};
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 |
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.