Code Monkey home page Code Monkey logo

jquery-ripple's Introduction

jQuery-ripple

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

Installation

jQuery-ripple can be installed through Bower.

$ bower 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

jquery-ripple's People

Contributors

adamsea avatar hustkiwi 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.