paper-ripple | Vaadin

Adds a Material Design ripple effect to UI elements

Published on NPM Build status Published on


paper-ripple provides a visual effect that other paper elements can use to simulate a rippling effect emanating from the point of contact. The effect can be visualized as a concentric circle with motion.

See: Documentation, Demo.



npm install --save @polymer/paper-ripple

In an html file

    <script type="module">
      import '@polymer/paper-ripple/paper-ripple.js';
    <div style="position: relative">
      <paper-ripple>Click here</paper-ripple>

In a Polymer 3 element

import {PolymerElement, html} from '@polymer/polymer';
import '@polymer/paper-ripple/paper-ripple.js';

class SampleElement extends PolymerElement {
  static get template() {
    return html`
      <div style="position: relative">
        <paper-ripple>Click here</paper-ripple>
customElements.define('sample-element', SampleElement);


If you want to send a PR to this element, here are the instructions for running the tests and demo locally:


git clone
cd paper-ripple
npm install
npm install -g polymer-cli

Running the demo locally

polymer serve --npm

Running the tests

polymer test --npm


Link to this version
ImportedReleased 14 September 2018BSD 3-clause "New" or "Revised" License
Framework Support
Polymer 1.0+
Polymer 3.0+
Also supported:
Polymer 2 (2.1.1)
Browser Compatibility
Install with
npm install @polymer/paper-ripple"@3.0.1"
Run the above npm command in your project folder. If you have any issues installing, please contact the author.
Release notes - Version 3.0.1


  • @polymer/iron-a11y-keys-behavior#^3.0.0-pre.26
  • @polymer/polymer#^3.0.0