Giter Club home page Giter Club logo

material-ripple-effects's Introduction

material-ripple-effects

Material Design Ripple Effects.

material-ripple-effects makes you able to have Material Design Ripple Effect on any element you want.

material-ripple-effects comes with two colors:

  1. Light
  2. Dark

Installation

Using NPM or Yarn

  1. Install the material-ripple-effects from npm or yarn.
npm i material-ripple-effects

yarn add material-ripple-effects
  1. Import the material-ripple-effects in to your project.
import Ripple from 'material-ripple-effects';
  1. material-ripple-effects works using react events on the element. You need to initialize the Ripple() object first and then use its create() method on the element event.
import React from "react";
import Ripple from 'material-ripple-effects';

export default function Button() {
  const ripple = new Ripple();

  return (
    <>
      <button onMouseUp={(e) => ripple.create(e, 'light')>Material Ripple</button>
      <button onMouseUp={(e) => ripple.create(e, 'dark')>Material Ripple</button>
    </>
  );
}

Using CDN

  1. Add the CDN script of material-ripple-effects in to your HTML file.
<script crossorigin src="https://unpkg.com/material-ripple-effects/ripple.js"></script>
  1. material-ripple-effects cdn works using the data attribute on the element, set the data-ripple-light or data-ripple-dark on the element you want to have material design ripple effect.
<button data-ripple-light="true">Material Ripple</button>
<button data-ripple-dark="true">Material Ripple</button>

material-ripple-effects's People

Contributors

sajadevo 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.