Code Monkey home page Code Monkey logo

meeink's Introduction

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

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 People

Contributors

bezenson avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.