# jquery-ripple

> jQuery Plugin for a ripple effect inspired by Google Material Design

Latest version **0.2.4** (published 2017-11-24) · MIT license · 0 weekly downloads

## Install

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

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.4 |
| Published | 2017-11-24 |
| First published | 2017-06-14 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 30 |
| Author | Eric Adams |
| Maintainers | hustkiwi |
| Keywords | jQuery, Plugins, effects |

## Links

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

## Alternatives

- [gamedig](https://npm.io/package/gamedig.md) — 29.3K weekly downloads
- [join-monster](https://npm.io/package/join-monster.md) — 12.8K weekly downloads
- [masked](https://npm.io/package/masked.md) — 5.5K weekly downloads
- [@comunica/actor-query-process-explain-logical](https://npm.io/package/@comunica/actor-query-process-explain-logical.md) — 4.7K weekly downloads
- [@veracity/vui](https://npm.io/package/@veracity/vui.md) — 4.6K weekly downloads

## Recent versions

- 0.2.4 (latest) — 2017-11-24
- 0.2.3 — 2017-11-24
- 0.2.2 — 2017-11-24
- 0.2.1 — 2017-06-14

## README

jQuery-ripple
=============

A jQuery Plugin for a ripple effect inspired by Google Material Design.

### Installation

jQuery-ripple can be installed through [Bower](http://bower.io/).

    $ bower install jquery.ripple --save

Or through [npm](https://docs.npmjs.com/)
    
    $ npm install jquery-ripple --save

### Usage

1. Include the required jquery.ripple.css in the head section of your document.

    ```
    <link rel="stylesheet" href="bower_components/jquery-ripple/jquery.ripple.css">
    ```
2. Include the latest version of jQuery and jQuery-ripple in your document.

    ```
    <script src="//code.jquery.com/jquery-latest.min.js"></script>
    <script src="bower_components/jquery-ripple/jquery.ripple.js"></script>
    ```
3. Create an element with the `[data-ripple]` data attribute defined.

    ```
    <button data-ripple>Button</button>
    ```
4. Call the plugin on the element.

    ```
    $('[data-ripple]').ripple();
    ```

### Customization

Optionally, you can pass a different CSS color to use for the ripple ink:

```
$('[data-ripple]').ripple({ color: '#EF5734' });
```

### Events

jQuery-ripple introduces three events that you can hook into for additional functionality:

| Event Name | Description |
|----------------|-----------------------------------------------------------------------------------------------------|
| *'beforeripple'* | Fired on touchstart/mousedown before ripple-active class is added to the DOM |
| *'afterripple'* | Fired on touchend/mouseup/mouseleave before ripple-active class is removed from the DOM |

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