# react-circle-modal

> Modal component with circle animation with many options

Latest version **0.0.2** (published 2021-05-21) · MIT license · 0 weekly downloads

## Install

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

## Health

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

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.2 |
| Published | 2021-05-21 |
| First published | 2021-05-21 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Node | >=10 |
| Dependencies | 3 |
| Unpacked size | 31.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 14 |
| Author | lucasfloriani |
| Maintainers | lucasfloriani |

## Links

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

## Dependencies (3)

- [react-use](https://npm.io/package/react-use.md) ^17.2.4
- [react-useportal](https://npm.io/package/react-useportal.md) ^1.0.14
- [styled-components](https://npm.io/package/styled-components.md) ^5.3.0

## Recent versions

- 0.0.2 (latest) — 2021-05-21
- 0.0.1 — 2021-05-21

## README

# react-circle-modal

> Modal component with circle animation with many options

[![NPM](https://img.shields.io/npm/v/react-circle-modal.svg)](https://www.npmjs.com/package/react-circle-modal) [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)

## Install

```bash
npm i react-circle-modal
yarn add react-circle-modal
```

## Usage

```tsx
import React from 'react'
import ReactCircleModal from 'react-circle-modal'

const Example = () => {
  return (
    <ReactCircleModal
      backgroundColor="#97349a"
      toogleComponent={onClick => (
        <button onClick={onClick}>
          Click here to open modal
        </button>
      )}
      // Optional fields and their default values
      offsetX={0}
      offsetY={0}
    >
      {(onClick) => (
        <div style={{ backgroundColor: '#fff', padding: '1em' }}>
          <p>
            Content inside of modal
          </p>
          <button onClick={onClick}>
            Click here to close modal
          </button>
        </div>
      )}
    </ReactCircleModal>
  )
}

export default Example
```

## License

MIT © [lucasfloriani](https://github.com/lucasfloriani)

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