bezenson / meeink

Material Design click effect

MeeInk v1.0.0

MeeInk is a jQuery plugin which allows you to easily add material design ink effect to elements when you click them.

Plugin is based on CSS animation what give you good performance including mobile devices.

Demo

Check out demo page here.

Setup

Install with Bower

bower install MeeInk --save

Install with NPM

npm install meeink --save

Include scripts

<script src="https://ajax.googleapis.com/ajax/libs/jquery/2.2.0/jquery.min.js"></script>
<script src="jquery.mee-ink.js"></script>

Include styles

<link rel="stylesheet" href="mee-ink.css">

Initialize plugin

$(document).ready(function() {
    $('.btn').meeInk({
        // options
    });
});

Documentation

Plugin have several number of options which allows you to customize it as you want.

animationClass

animationClass: 'mee-ink-animated mee-ink-animation'

Class which triggers to start CSS animation.

elementClass

elementClass: 'mee-ink-el'

Class that is added to initialized element.

inkClass

inkClass: 'mee-ink'

Class for ink inside element with styles.

overflowHiddenClass

overflowHiddenClass: 'mee-ink-overflow-hidden'

Class will be added if your element don't have overflow: hidden.

positionRelativeClass

positionRelativeClass: 'mee-ink-pos-relative'

Class will be added if your element have position: static, because ink inside element positioned absolutely relative to element.

Issues

Found an issue? You are welcome here.

meeink's Issues

no click event

Hello, nice plugin, but when I use the plugin, the onclick event for an tag with class ".btn" is not fired anymore. Any idea?