https://github.com/likerrr/jquery-epulse

jQuery plugin for creating ripple effects on event occurrence
https://github.com/likerrr/jquery-epulse

Last synced: about 9 hours ago
JSON representation

jQuery plugin for creating ripple effects on event occurrence

• Host: GitHub
• URL: https://github.com/likerrr/jquery-epulse
• Owner: likerRr
• Created: 2015-08-14T09:48:49.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2015-08-18T10:44:30.000Z (about 9 years ago)
• Last Synced: 2024-10-11T09:42:51.882Z (about 1 month ago)
• Language: JavaScript
• Homepage: https://likerrr.github.io/jquery-epulse/
• Size: 191 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# ePulse

Lightweight(1.7kb) jQuery plugin for creating ripple effects on event occurrence

# Install

## npm

If you use build system that supports CommonJS or AMD modules, then install through `npm`

`npm install jquery-epulse`

Then include in your *.js file

```javascript

require('jquery-epulse');

```

## bower

In future releases

## manual

For manual installation you can download one of the latest [release](https://github.com/likerRr/jquery-epulse/releases) or clone this repo:

`git clone https://github.com/likerRr/jquery-epulse.git`

Then just include plugin in your html

```html

```

There are 3 different versions available for including:

- `/dist/dev.jquery-epulse.min.js` - contains minified code and sourcemap for developing purposes

- `/dist/jquery-epulse.min.js` - minified, ready for production version

- `/dist/jquery-epulse.js` - built from source version

# How to

ePulse is jQuery plugin, so you can use it like other jQuery functions. So, here is simple ripple effect [example](https://likerrr.github.io/jquery-epulse/#how-to):

```css

button {

  // for proper work, position must be either relative or absolute

  position: relative;

  overflow: hidden;

  // simple button styles

  background: #9C27B0;

  color: white;

  padding: 5px;

  border: transparent;

}

```

```html

I'm a button

```

```javascript

$.fn.ripple = function() {

  $(this).ePulse({bgColor: 'rgba(225, 190, 231, 0.5)', event: 'mousedown'});

}

$("button").ripple();

```

# LICENSE

http://likerrr.mit-license.org