# maximez_modal

> The Modal component allows you to create customizable modal dialogs for your React applications.

Latest version **0.0.3** (published 2023-10-06) · 0 weekly downloads

## Install

```sh
npm install maximez_modal
pnpm add maximez_modal
yarn add maximez_modal
bun add maximez_modal
```

## Health

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

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types; low quality score; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.3 |
| Published | 2023-10-06 |
| First published | 2023-10-03 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 20.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | maximezinderstein |

## Links

- npm: https://www.npmjs.com/package/maximez_modal
- npm.io page: https://npm.io/package/maximez_modal

## Recent versions

- 0.0.3 (latest) — 2023-10-06
- 0.0.2 — 2023-10-06
- 0.0.1 — 2023-10-04
- 0.0.0 — 2023-10-03

## README

# Modal Component

The Modal component allows you to create customizable modal dialogs for your React applications.

## Prerequisites

- [NodeJS (**version v20.0.0 or higher**)](https://nodejs.org/en/)
- [npm (**v9.6.4 or higher**)](https://www.npmjs.com/)
- [react (**version ^18.2.0 or higher**)](https://react.dev/)

## Installation

You can install this component via npm:

`npm install maximez_modal`

## Usage

# Import the component

`import { Modal } from 'maximez_modal';`

# Include the Modal componentn in your JSX

```
<Modal
  closeModal={closeModalFunction}
  maxWidth={number}
  modalBackgroundColor={string}
  iconColor={string}
  hoveredIconBackgroundColor={string}>
  {/* Content for your modal */}
</Modal>
```

# Customiwe the component by passing props

- `closeModal`: A function to close the modal.
- `maxWidth`: The maximum width of the modal.
- `modalBackgroundColor`: The background color of the modal.
- `iconColor`: The color of the close icon.
- `hoveredIconBackgroundColor`: The background color of the close icon on hover.
- `modalBackground`: The background color behind the modal (light or dark).

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