# ripple-button

> ripple-button

Latest version **1.0.9** (published 2020-03-18) · ISC license · 0 weekly downloads

## Install

```sh
npm install ripple-button
pnpm add ripple-button
yarn add ripple-button
bun add ripple-button
```

## Health

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

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.9 |
| Published | 2020-03-18 |
| First published | 2020-03-17 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 13 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | ifmiss |
| Maintainers | ifmiss |
| Keywords | button, ripple, react-ripple |

## Links

- npm: https://www.npmjs.com/package/ripple-button
- Repository: https://github.com/IFmiss/ripple-button
- Homepage: https://github.com/IFmiss/ripple-button#readme
- Issues: https://github.com/IFmiss/ripple-button/issues
- npm.io page: https://npm.io/package/ripple-button

## Recent versions

- 1.0.9 (latest) — 2020-03-18
- 1.0.8 — 2020-03-18
- 1.0.7 — 2020-03-18
- 1.0.6 — 2020-03-18
- 1.0.5 — 2020-03-17
- 1.0.4 — 2020-03-17
- 1.0.3 — 2020-03-17
- 1.0.2 — 2020-03-17
- 1.0.1 — 2020-03-17
- 1.0.0 — 2020-03-17

## README

# ripple-button

```code
npm i ripple-button
```

or

```code
yarn add ripple-button
```

```tsx
import Ripple from 'ripple-button'
<Ripple>
  <h1>hello ripple</h1>
</Ripple>
```

### props
- color  【String】 ripple color  default: rgba(0, 0, 0, 0.3);
- duration 【Number】 Animation time  default: 800ms 

```tsx
import Ripple from 'ripple-button'
<Ripple color="rgba(12, 33, 124, 0.3)" duration={500}>
  <h1>hello ripple</h1>
</Ripple>
```

### useRipple
you can bind ripple on DOM element

```tsx
import { useRipple } from 'ripple-button'
useRipple(document.body, 'rgba(12, 232, 44, 0.1)', 600)
```

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