# fukuro-react-modal

> Fukuro React Modal

Latest version **0.0.6** (published 2019-07-09) · MIT license · 0 weekly downloads

## Install

```sh
npm install fukuro-react-modal
pnpm add fukuro-react-modal
yarn add fukuro-react-modal
bun add fukuro-react-modal
```

## Health

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

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.6 |
| Published | 2019-07-09 |
| First published | 2019-04-13 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 20.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Fukurosan |
| Maintainers | fukurosan |
| Keywords | React, Modal, Factory, ModalFactory |

## Links

- npm: https://www.npmjs.com/package/fukuro-react-modal
- Repository: https://github.com/fukurosan/fukuro-react-modal
- Issues: https://github.com/fukurosan/fukuro-react-modal/issues
- npm.io page: https://npm.io/package/fukuro-react-modal

## 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

- 0.0.6 (latest) — 2019-07-09
- 0.0.5 — 2019-07-09
- 0.0.4 — 2019-04-22
- 0.0.3 — 2019-04-13
- 0.0.2 — 2019-04-13
- 0.0.1 — 2019-04-13

## README

# Fukuro React Modal
This is a zero dependency modal library for React that includes resizing and moving functionality.

This library uses ReactDOM portal to render the modal outside of the root div in a sibling element. This minimizes issues with z-indexes, overflows, etc.

You can either use this library as-is to create simple yet powerful modal windows in React, or learn from the source code, and build your own modal factory for your project.

### Installing and using
Install using NPM:
```
npm install fukuro-react-modal
```

Then you can do the following to use it:
```
import FukuroModal from 'fukuro-react-modal'
(...)
const header = "Header Content" //optional
const movable={true} //requires header to be set
const footer = "Footer Content" //optional
const sizable={true} //requires footer to be set

{YourCriteriaForShowingTheModal ?
  <FukuroModal header={header} footer={footer} movable={movable} sizable={sizable} onClose={() => { this.toggleYourCriteraForShowingTheModalFunction() }}>
    Your body content goes here!
  </FukuroModal>
: null}
}
```

Use the onClose prop to send a reference to a handler that changes the state between opened and closed in your parent component. This will fire when the backdrop is clicked.

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