# fullscreenreact-modal

> fullScreen react modal which can be configured with the text you want and picture

Latest version **1.0.1** (published 2023-10-17) · 0 weekly downloads

## Install

```sh
npm install fullscreenreact-modal
pnpm add fullscreenreact-modal
yarn add fullscreenreact-modal
bun add fullscreenreact-modal
```

## Health

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

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2023-10-17 |
| First published | 2023-10-17 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 3 |
| Unpacked size | 5.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Yann LECERF |
| Maintainers | belin |
| Keywords | react, TypeScript, modal, fullScreen, Sass |

## Links

- npm: https://www.npmjs.com/package/fullscreenreact-modal
- Repository: https://github.com/Belin27000/fullscreen-react-modal
- Homepage: https://github.com/Belin27000/fullscreen-react-modal#readme
- Issues: https://github.com/Belin27000/fullscreen-react-modal/issues
- npm.io page: https://npm.io/package/fullscreenreact-modal

## Dependencies (3)

- [react](https://npm.io/package/react.md) ^18.2.0
- [react-dom](https://npm.io/package/react-dom.md) ^18.2.0
- [@babel/polyfill](https://npm.io/package/@babel/polyfill.md) ^7.12.1

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 1.0.1 (latest) — 2023-10-17
- 1.0.0 — 2023-10-17

## README

<h1 align="center">Welcome to fullscreenreact-modal 👋</h1>
<p>
  <a href="https://www.npmjs.com/package/fullscreenreact-modal" target="_blank">
    <img alt="Version" src="https://img.shields.io/npm/v/fullscreenreact-modal.svg">
  </a>
  <a href="https://github.com/Belin27000/fullscreen-react-modal#readme" target="_blank">
    <img alt="Documentation" src="https://img.shields.io/badge/documentation-yes-brightgreen.svg" />
  </a>
  <a href="https://github.com/Belin27000/fullscreen-react-modal/graphs/commit-activity" target="_blank">
    <img alt="Maintenance" src="https://img.shields.io/badge/Maintained%3F-yes-green.svg" />
  </a>
  <a href="https://github.com/Belin27000/fullscreen-react-modal/blob/master/LICENSE" target="_blank">
    <img alt="License: MIT" src="https://img.shields.io/github/license/Belin27000/fullscreenreact-modal" />
  </a>
</p>

fullScreen react modal which can be configured with the text you want and picture

## How to use it

### 1-Install

```sh
npm i fullscreenreact-modal
```

### 2-Import `FullScreenModal` (you can name it as you want)

 - import `FullScreenModal` from 'fullscreenreact-modal'

### 3-Use it (you can name it as you want)
 
 Mandatory: 
   - you have to pass boolean value to: isActive={`showModal`}
   - `handleCloseModal` is the function which close the modal you can use your own code

   ```js
   const [showModal, setShowModal] = useState(false);
   const handleCloseModal = () => {
        setShowModal(false);
    };
   ```

 ```js
   return(
    ... your code ... 
   <FullScreenModal isActive={showModal} text="whatever you want" imgPath='image path or can be empty' onClose={handleCloseModal} />
   ),
```




## Author

👤 **Yann LECERF**

* Website: https://conseilsandtechs.com/
* Github: [@Belin27000](https://github.com/Belin27000)

## Show your support

Give a ⭐️ if this project helped you!

## 📝 License

Copyright © 2023 [Yann LECERF](https://github.com/Belin27000).<br />
This project is [MIT](https://github.com/Belin27000/fullscreen-react-modal/blob/master/LICENSE) licensed.

***
_This README was generated with ❤️ by [readme-md-generator](https://github.com/kefranabg/readme-md-generator)_

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