# bf-component-modal

> Simple modal component for react project.

Latest version **1.1.2** (published 2022-11-02) · MIT license · 0 weekly downloads

## Install

```sh
npm install bf-component-modal
pnpm add bf-component-modal
yarn add bf-component-modal
bun add bf-component-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.1.2 |
| Published | 2022-11-02 |
| First published | 2022-11-01 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 2 |
| Unpacked size | 10.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Flanquart Bastien |
| Maintainers | awizy63 |
| Keywords | react, modal, component |

## Links

- npm: https://www.npmjs.com/package/bf-component-modal
- Repository: https://github.com/AwiZy63/bf_modal
- Homepage: https://github.com/AwiZy63/bf_modal#readme
- Issues: https://github.com/AwiZy63/bf_modal/issues
- npm.io page: https://npm.io/package/bf-component-modal

## Dependencies (2)

- [postcss](https://npm.io/package/postcss.md) ^8.0
- [react-transition-group](https://npm.io/package/react-transition-group.md) ^4.4.2

## 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.1.2 (latest) — 2022-11-02
- 1.1.1 — 2022-11-02
- 1.1.0 — 2022-11-02
- 1.0.9 — 2022-11-01
- 1.0.8 — 2022-11-01
- 1.0.7 — 2022-11-01
- 1.0.6 — 2022-11-01
- 1.0.5 — 2022-11-01
- 1.0.4 — 2022-11-01
- 1.0.3 — 2022-11-01
- 1.0.2 — 2022-11-01
- 1.0.1 — 2022-11-01
- 1.0.0 — 2022-11-01

## README

# BF Component Modal

This module has been created for project 14 of DAJR OpenClassroom formation

## Installation

```bash
npm install bf-component-modal --save
```

### How to use

```js
import React, { useState } from 'react';
import { Modal } from 'bf-component-modal';

function myComponent() {
    const [showModal, setShowModal] = useState(false);
    return (
        <Modal
            title={"My modal header title"}
            description={"My modal body content"}
            show={showModal} // Boolean used to show or not the modal
            onClose={(event) => setShowModal(false)} // Action when modal closing
        />
    );
}

export default myComponent;

```

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