paper-icon-button | Vaadin

A Material Design icon button

Published on NPM Build status Published on


paper-icon-button is a button with an image placed at the center. When the user touches the button, a ripple effect emanates from the center of the button.

paper-icon-button does not include a default icon set. To use icons from the default set, include @polymer/iron-icons/iron-icons.js, and use the icon attribute to specify which icon from the icon set to use.

See: Documentation, Demo.



npm install --save @polymer/paper-icon-button

In an html file

    <script type="module">
      import '@polymer/paper-icon-button/paper-icon-button.js';
      import '@polymer/iron-icons/iron-icons.js';
    <paper-icon-button icon="favorite"></paper-icon-button>

In a Polymer 3 element

import {PolymerElement, html} from '@polymer/polymer';
import '@polymer/paper-icon-button/paper-icon-button.js';
import '@polymer/iron-icons/iron-icons.js';

class SampleElement extends PolymerElement {
  static get template() {
    return html`
      <paper-icon-button icon="favorite"></paper-icon-button>
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-icon-button
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 16 January 2019BSD 3-clause "New" or "Revised" License
Framework Support
Polymer 1.0+
Polymer 3.0+
Also supported:
Polymer 2 (2.2.1)
Browser Compatibility
Install with
npm install @polymer/paper-icon-button"@3.0.2"
Run the above npm command in your project folder. If you have any issues installing, please contact the author.
Release notes - Version 3.0.2


  • @polymer/polymer#^3.0.0
  • @polymer/iron-icon#^3.0.0-pre.26
  • @polymer/paper-behaviors#^3.0.0-pre.27
  • @polymer/paper-styles#^3.0.0-pre.26