# react-ripples

> The ripple effect. Ripples everywhere

Latest version **2.2.1** (published 2019-08-21) · MIT license · 0 weekly downloads

## Install

```sh
npm install react-ripples
pnpm add react-ripples
yarn add react-ripples
bun add react-ripples
```

## Health

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

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.2.1 |
| Published | 2019-08-21 |
| First published | 2016-06-05 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 37.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 205 |
| Author | Rocky Wu |
| Maintainers | rwu823 |
| Keywords | react, ripple, ripples, effect, button, material |

## Links

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

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

- 2.2.1 (latest) — 2019-08-21
- 2.2.0 — 2019-08-21
- 2.1.1 — 2019-05-29
- 2.1.0 — 2019-05-29
- 2.0.1 — 2019-05-27
- 2.0.0 — 2019-05-27
- 1.1.2 — 2017-12-12
- 1.1.1 — 2017-12-12
- 1.1.0 — 2017-12-09
- 1.0.0 — 2017-12-08
- 0.4.0 — 2017-04-22
- 0.3.1 — 2017-01-28
- 0.3.0 — 2017-01-28
- 0.2.1 — 2016-06-06
- 0.2.0 — 2016-06-05
- … 2 more at https://npm.io/package/react-ripples/versions

## README

<h1 align="center">
  <img width="200" src="./static/logo.png"/>
  <p>react-ripples</p>
  <a href="https://circleci.com/gh/rwu823/react-ripples" alt="Build Status">
    <img src="https://img.shields.io/circleci/build/github/rwu823/react-ripples/master?style=for-the-badge&logo=circleci" />
  </a>
</h1>

<p align="center">
  <a href="https://www.npmjs.org/package/react-ripples">
    <img src="https://img.shields.io/npm/v/react-ripples?style=for-the-badge&logo=npm"/>
  </a>
  <a href="https://codecov.io/github/rwu823/react-ripples">
    <img src="https://img.shields.io/codecov/c/github/rwu823/react-ripples/master?style=for-the-badge&logo=codecov"/>
  </a>
  <img src="https://img.shields.io/bundlephobia/minzip/react-ripples?style=for-the-badge&logo=webpack" />
</p>

<h4 align="center">
  <sub>Material ripple effect, ripples everywhere</sub>
</h4>

<h3 align="center">
  <a href="https://rwu823.github.io/react-ripples">Live Demo</a>
</h3>

## Attraction

- ✅ Zero dependencies
- 🚀 Tiny and blazing fast (Pure Component)
- ⚡ Typescript and definition file supported
- 🎨 Pure CSS animation
- 🌍 SSR supported

## Installation

```sh
$ npm install --save react-ripples
```

or

```sh
$ yarn add react-ripples
```

## Usage

```jsx
import Ripples from 'react-ripples'

render() {
  <Ripples>
    <button>Ripple Button</button>
  </Ripples>
}
```

## API

### createRipples([defaultProps])

Extends default props without HOC

```jsx
import { createRipples } from 'react-ripples'

const MyRipples = createRipples({
  color: 'purple',
  during: 2200,
})
```

### Props

```javascript
static propTypes = {
  during: PropTypes.number,
  color: PropTypes.string,
}

static defaultProps = {
  during: 600,
  color: 'rgba(0, 0, 0, .3)',
}
```

| Property | Description                   |
| -------- | ----------------------------- |
| during   | The css animate duration [ms] |
| color    | The ripple's background color |

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