# material-ripple-effects

> Material Design Ripple Effects

Latest version **2.0.1** (published 2021-03-20) · MIT license · 0 weekly downloads

## Install

```sh
npm install material-ripple-effects
pnpm add material-ripple-effects
yarn add material-ripple-effects
bun add material-ripple-effects
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.1 |
| Published | 2021-03-20 |
| First published | 2021-03-19 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 7.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 19 |
| Author | Sajad Ahmad Nawabi |
| Maintainers | sajadevo |
| Keywords | material design, ripple effect, material-ripple, ripple |

## Links

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

## Recent versions

- 2.0.1 (latest) — 2021-03-20
- 2.0.0 — 2021-03-19

## README

# material-ripple-effects

### Material Design Ripple Effects.

material-ripple-effects makes you able to have Material Design Ripple Effect on any element you want.

#### material-ripple-effects comes with two colors:

1. Light
2. Dark

## Installation

### Using NPM or Yarn

1. Install the material-ripple-effects from npm or yarn.

```
npm i material-ripple-effects

yarn add material-ripple-effects
```

2. Import the material-ripple-effects in to your project.

```
import Ripple from 'material-ripple-effects';
```

3. material-ripple-effects works using react events on the element. You need to initialize the Ripple() object first and then use its create() method on the element event.

```
import React from "react";
import Ripple from 'material-ripple-effects';

export default function Button() {
  const ripple = new Ripple();

  return (
    <>
      <button onMouseUp={(e) => ripple.create(e, 'light')>Material Ripple</button>
      <button onMouseUp={(e) => ripple.create(e, 'dark')>Material Ripple</button>
    </>
  );
}
```

### Using CDN

1. Add the CDN script of material-ripple-effects in to your HTML file.

```
<script crossorigin src="https://unpkg.com/material-ripple-effects/ripple.js"></script>
```

2. material-ripple-effects cdn works using the data attribute on the element, set the `data-ripple-light` or `data-ripple-dark` on the element you want to have material design ripple effect.

```
<button data-ripple-light="true">Material Ripple</button>
<button data-ripple-dark="true">Material Ripple</button>
```

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