Skip to content

Yfill/waves

Repository files navigation

GitHub license Code Style NPM Package Monthly Downloads Build Size Dependencies Status DevDependencies Status

Click the wave effect.

Install

using npm:

npm install @yfill/waves --save

or using yarn:

yarn add @yfill/waves

Usage

  • Import resources and execute the run method.

    import Waves from "@yfill/waves";
    Waves.run();
    <script src="https://unpkg.com/@yfill/waves" onload="Waves.run();"></script>
  • Set the waves attribute on the tag

    y-waves-[?(light|dark|main)]
    y-waves-box-shadow
    

Code example

<div class="item" y-waves>waves default</div>
<div class="item" y-waves-light>waves light</div>
<div class="item" y-waves-dark>waves dark</div>
<div class="item" y-waves-main>waves main</div>
<div class="item" y-waves y-waves-box-shadow>waves box shadow</div>
<img
  src="https://images.unsplash.com/photo-1606054512716-fb198b6686c9?ixlib=rb-1.2.1&ixid=eyJhcHBfaWQiOjEyMDd9&auto=format&fit=crop&w=751&q=80"
  y-waves
/>