paper-icon-button
A Material Design icon button
<paper-icon-button>
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.
Usage
Installation
npm install --save @polymer/paper-icon-button
In an html file
<html>
<head>
<script type="module">
import '@polymer/paper-icon-button/paper-icon-button.js';
import '@polymer/iron-icons/iron-icons.js';
</script>
</head>
<body>
<paper-icon-button icon="favorite"></paper-icon-button>
</body>
</html>
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);
Contributing
If you want to send a PR to this element, here are the instructions for running the tests and demo locally:
Installation
git clone https://github.com/PolymerElements/paper-icon-button
cd paper-icon-button
npm install
npm install -g polymer-cli
Running the demo locally
polymer serve --npm
open http://127.0.0.1:<port>/demo/
Running the tests
polymer test --npm
Links
Compatibility
Was this helpful? Need more help?
Leave a comment or a question below. You can also join
the chat on Discord or
ask questions on StackOverflow.
Version
Dependencies
- @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
- Released
- 2019-01-16
- Maturity
- IMPORTED
- License
- BSD 3-clause "New" or "Revised" License
Compatibility
- Framework
- Polymer 1.0+
- Polymer 3.0+
- Polymer 2.0+ in 2.2.1
- Browser
- Browser Independent
paper-icon-button - Vaadin Add-on Directory
A Material Design icon buttonGitHub Homepage
View on NPM
Issue tracker
License
Online Demo
View on GitHub
paper-icon-button version 0.8.0
### Dependencies
polymer/polymer#v0.8.0-rc.7
* polymerelements/iron-flex-layout#^0.8.0
* polymerelements/iron-icon#^0.8.0
* polymerelements/iron-icons#^0.8.0
* polymerelements/paper-behaviors#^0.8.0
* polymerelements/paper-ripple#^0.8.0
* polymerelements/paper-styles#^0.8.0
paper-icon-button version 0.9.0
### Dependencies
polymer/polymer#v0.9.0-rc.1
* polymerelements/iron-flex-layout#^0.9.0
* polymerelements/iron-icon#^0.9.0
* polymerelements/iron-icons#^0.9.0
* polymerelements/paper-behaviors#^0.9.0
* polymerelements/paper-ripple#^0.9.0
* polymerelements/paper-styles#^0.9.0
paper-icon-button version 0.9.1
### Dependencies
polymerelements/iron-flex-layout#^0.9.0
* polymerelements/iron-icon#^0.9.0
* polymerelements/iron-icons#^0.9.0
* polymerelements/paper-behaviors#^0.9.0
* polymerelements/paper-ripple#^0.9.0
* polymerelements/paper-styles#^0.9.0
* Polymer/polymer#^0.9.0
paper-icon-button version 0.9.2
### Dependencies
polymerelements/iron-flex-layout#^0.9.0
* polymerelements/iron-icon#^0.9.0
* polymerelements/iron-icons#^0.9.0
* polymerelements/paper-behaviors#^0.9.3
* polymerelements/paper-ripple#^0.9.0
* polymerelements/paper-styles#^0.9.0
* Polymer/polymer#^0.9.0
paper-icon-button version 1.0.0
### Dependencies
* iron-flex-layout#polymerelements/iron-flex-layout#^1.0.0
* iron-icon#polymerelements/iron-icon#^1.0.0
* iron-icons#polymerelements/iron-icons#^1.0.0
* paper-behaviors#polymerelements/paper-behaviors#^1.0.0
* paper-ripple#polymerelements/paper-ripple#^1.0.0
* paper-styles#polymerelements/paper-styles#^1.0.0
* polymer#Polymer/polymer#^1.0.0
paper-icon-button version 1.0.1
### Dependencies
* iron-flex-layout#polymerelements/iron-flex-layout#^1.0.0
* iron-icon#polymerelements/iron-icon#^1.0.0
* iron-icons#polymerelements/iron-icons#^1.0.0
* paper-behaviors#polymerelements/paper-behaviors#^1.0.0
* paper-ripple#polymerelements/paper-ripple#^1.0.0
* paper-styles#polymerelements/paper-styles#^1.0.0
* polymer#Polymer/polymer#^1.0.0
paper-icon-button version 1.0.2
### Dependencies
* iron-flex-layout#polymerelements/iron-flex-layout#^1.0.0
* iron-icon#polymerelements/iron-icon#^1.0.0
* iron-icons#polymerelements/iron-icons#^1.0.0
* paper-behaviors#polymerelements/paper-behaviors#^1.0.0
* paper-ripple#polymerelements/paper-ripple#^1.0.0
* paper-styles#polymerelements/paper-styles#^1.0.0
* polymer#Polymer/polymer#^1.0.0
paper-icon-button version 1.0.3
### Dependencies
* iron-flex-layout#polymerelements/iron-flex-layout#^1.0.0
* iron-icon#polymerelements/iron-icon#^1.0.0
* iron-icons#polymerelements/iron-icons#^1.0.0
* paper-behaviors#polymerelements/paper-behaviors#^1.0.0
* paper-ripple#polymerelements/paper-ripple#^1.0.0
* paper-styles#polymerelements/paper-styles#^1.0.0
* polymer#Polymer/polymer#^1.0.0
paper-icon-button version 1.0.4
### Dependencies
* polymer#Polymer/polymer#^1.1.0
* iron-flex-layout#PolymerElements/iron-flex-layout#^1.0.0
* iron-icon#PolymerElements/iron-icon#^1.0.0
* iron-icons#PolymerElements/iron-icons#^1.0.0
* paper-behaviors#PolymerElements/paper-behaviors#^1.0.0
* paper-ripple#PolymerElements/paper-ripple#^1.0.0
* paper-styles#PolymerElements/paper-styles#^1.0.0
paper-icon-button version 1.0.5
### Dependencies
* polymer#Polymer/polymer#^1.1.0
* iron-flex-layout#PolymerElements/iron-flex-layout#^1.0.0
* iron-icon#PolymerElements/iron-icon#^1.0.0
* iron-icons#PolymerElements/iron-icons#^1.0.0
* paper-behaviors#PolymerElements/paper-behaviors#^1.0.0
* paper-ripple#PolymerElements/paper-ripple#^1.0.0
* paper-styles#PolymerElements/paper-styles#^1.0.0
paper-icon-button version 1.0.6
### Dependencies
* polymer#Polymer/polymer#^1.1.0
* iron-flex-layout#PolymerElements/iron-flex-layout#^1.0.0
* iron-icon#PolymerElements/iron-icon#^1.0.0
* iron-icons#PolymerElements/iron-icons#^1.0.0
* paper-behaviors#PolymerElements/paper-behaviors#^1.0.0
* paper-ripple#PolymerElements/paper-ripple#^1.0.0
* paper-styles#PolymerElements/paper-styles#^1.0.0
paper-icon-button version 0.0.1
### Dependencies
* @polymer/polymer#^1.2.5-npm-test.2
* @polymer/iron-flex-layout#^0.0.1
* @polymer/iron-icon#^0.0.1
* @polymer/iron-icons#^0.0.1
* @polymer/paper-behaviors#^0.0.1
* @polymer/paper-ripple#^0.0.1
* @polymer/paper-styles#^0.0.1
paper-icon-button version 0.0.3
### Dependencies
* @polymer/polymer#^1.2.5-npm-test.2
* @polymer/iron-flex-layout#^0.0.3
* @polymer/iron-icon#^0.0.3
* @polymer/iron-icons#^0.0.3
* @polymer/paper-behaviors#^0.0.3
* @polymer/paper-ripple#^0.0.3
* @polymer/paper-styles#^0.0.3
paper-icon-button version 1.0.7
### Dependencies
* polymer#Polymer/polymer#^1.1.0
* iron-icon#PolymerElements/iron-icon#^1.0.0
* paper-behaviors#PolymerElements/paper-behaviors#^1.0.0
* paper-styles#PolymerElements/paper-styles#^1.0.0
paper-icon-button version 1.1.0
### Dependencies
* polymer#Polymer/polymer#^1.1.0
* iron-icon#PolymerElements/iron-icon#^1.0.0
* paper-behaviors#PolymerElements/paper-behaviors#^1.0.0
* paper-styles#PolymerElements/paper-styles#^1.0.0
paper-icon-button version 1.1.1
### Dependencies
* polymer#Polymer/polymer#^1.1.0
* iron-icon#PolymerElements/iron-icon#^1.0.0
* paper-behaviors#PolymerElements/paper-behaviors#^1.0.0
* paper-styles#PolymerElements/paper-styles#^1.0.0
paper-icon-button version 1.1.2
### Dependencies
* polymer#Polymer/polymer#^1.1.0
* iron-icon#PolymerElements/iron-icon#^1.0.0
* paper-behaviors#PolymerElements/paper-behaviors#^1.0.0
* paper-styles#PolymerElements/paper-styles#^1.0.0
paper-icon-button version 1.1.3
### Dependencies
* polymer#Polymer/polymer#^1.1.0
* iron-icon#PolymerElements/iron-icon#^1.0.0
* paper-behaviors#PolymerElements/paper-behaviors#^1.0.0
* paper-styles#PolymerElements/paper-styles#^1.0.0
paper-icon-button version 1.1.4
### Dependencies
* polymer#Polymer/polymer#^1.1.0
* iron-icon#PolymerElements/iron-icon#^1.0.0
* paper-behaviors#PolymerElements/paper-behaviors#^1.0.0
* paper-styles#PolymerElements/paper-styles#^1.0.0
paper-icon-button version 1.1.5
### Dependencies
* polymer#Polymer/polymer#^1.1.0
* iron-icon#PolymerElements/iron-icon#^1.0.0
* paper-behaviors#PolymerElements/paper-behaviors#^1.0.0
* paper-styles#PolymerElements/paper-styles#^1.0.0
paper-icon-button version 1.1.6
### Dependencies
* polymer#Polymer/polymer#^1.1.0
* iron-icon#PolymerElements/iron-icon#^1.0.0
* paper-behaviors#PolymerElements/paper-behaviors#^1.0.0
* paper-styles#PolymerElements/paper-styles#^1.0.0
paper-icon-button version 2.0.0
### Dependencies
* polymer#Polymer/polymer#1.9 - 2
* iron-icon#PolymerElements/iron-icon#1 - 2
* paper-behaviors#PolymerElements/paper-behaviors#1 - 2
* paper-styles#PolymerElements/paper-styles#1 - 2
paper-icon-button version 3.0.0-pre.1
### Dependencies
* @polymer/polymer#^3.0.0-pre.1
* @polymer/iron-icon#^3.0.0-pre.1
* @polymer/paper-behaviors#^3.0.0-pre.1
* @polymer/paper-styles#^3.0.0-pre.1
paper-icon-button version 2.0.1
### Dependencies
* polymer#Polymer/polymer#1.9 - 2
* iron-icon#PolymerElements/iron-icon#1 - 2
* paper-behaviors#PolymerElements/paper-behaviors#1 - 2
* paper-styles#PolymerElements/paper-styles#1 - 2
paper-icon-button version 3.0.0-pre.2
### Dependencies
* @polymer/polymer#^3.0.0-pre.1
* @polymer/iron-icon#^3.0.0-pre.1
* @polymer/paper-behaviors#^3.0.0-pre.1
* @polymer/paper-styles#^3.0.0-pre.1
paper-icon-button version 3.0.0-pre.3
### Dependencies
* @polymer/polymer#^3.0.0-pre.3
* @polymer/iron-icon#^3.0.0-pre.3
* @polymer/paper-behaviors#^3.0.0-pre.3
* @polymer/paper-styles#^3.0.0-pre.3
paper-icon-button version 3.0.0-pre.4
### Dependencies
* @polymer/polymer#^3.0.0-pre.4
* @polymer/iron-icon#^3.0.0-pre.4
* @polymer/paper-behaviors#^3.0.0-pre.4
* @polymer/paper-styles#^3.0.0-pre.4
paper-icon-button version 3.0.0-pre.6
### Dependencies
* @polymer/polymer#^3.0.0-pre.6
* @polymer/iron-icon#^3.0.0-pre.6
* @polymer/paper-behaviors#^3.0.0-pre.6
* @polymer/paper-styles#^3.0.0-pre.6
paper-icon-button version 3.0.0-pre.7
### Dependencies
* @polymer/polymer#^3.0.0-pre.7
* @polymer/iron-icon#^3.0.0-pre.7
* @polymer/paper-behaviors#^3.0.0-pre.7
* @polymer/paper-styles#^3.0.0-pre.7
paper-icon-button version 2.1.0
### Dependencies
* polymer#Polymer/polymer#1.9 - 2
* iron-icon#PolymerElements/iron-icon#1 - 2
* paper-behaviors#PolymerElements/paper-behaviors#1 - 2
* paper-styles#PolymerElements/paper-styles#1 - 2
paper-icon-button version 3.0.0-pre.8
### Dependencies
* @polymer/polymer#^3.0.0-pre.7
* @polymer/iron-icon#^3.0.0-pre.7
* @polymer/paper-behaviors#^3.0.0-pre.7
* @polymer/paper-styles#^3.0.0-pre.7
paper-icon-button version 3.0.0-pre.10
### Dependencies
* @polymer/polymer#^3.0.0-pre.10
* @polymer/iron-icon#^3.0.0-pre.10
* @polymer/paper-behaviors#^3.0.0-pre.10
* @polymer/paper-styles#^3.0.0-pre.10
paper-icon-button version 2.2.0
### Dependencies
* polymer#Polymer/polymer#1.9 - 2
* iron-icon#PolymerElements/iron-icon#1 - 2
* paper-behaviors#PolymerElements/paper-behaviors#1 - 2
* paper-styles#PolymerElements/paper-styles#1 - 2
paper-icon-button version 3.0.0-pre.11
### Dependencies
* @polymer/polymer#^3.0.0-pre.10
* @polymer/iron-icon#^3.0.0-pre.10
* @polymer/paper-behaviors#^3.0.0-pre.10
* @polymer/paper-styles#^3.0.0-pre.10
paper-icon-button version 3.0.0-pre.12
### Dependencies
* @polymer/polymer#3.0.0-pre.12
* @polymer/iron-icon#3.0.0-pre.12
* @polymer/paper-behaviors#3.0.0-pre.12
* @polymer/paper-styles#3.0.0-pre.12
paper-icon-button version 3.0.0-pre.13
### Dependencies
* @polymer/polymer#^3.0.0-pre.13
* @polymer/iron-icon#^3.0.0-pre.13
* @polymer/paper-behaviors#^3.0.0-pre.13
* @polymer/paper-styles#^3.0.0-pre.13
paper-icon-button version 3.0.0-pre.14
### Dependencies
* @polymer/polymer#^3.0.0-pre.13
* @polymer/iron-icon#^3.0.0-pre.14
* @polymer/paper-behaviors#^3.0.0-pre.14
* @polymer/paper-styles#^3.0.0-pre.14
paper-icon-button version 3.0.0-pre.15
### Dependencies
* @polymer/polymer#^3.0.0-pre.13
* @polymer/iron-icon#^3.0.0-pre.15
* @polymer/paper-behaviors#^3.0.0-pre.15
* @polymer/paper-styles#^3.0.0-pre.15
paper-icon-button version 3.0.0-pre.16
### Dependencies
* @polymer/polymer#^3.0.0-pre.13
* @polymer/iron-icon#^3.0.0-pre.16
* @polymer/paper-behaviors#^3.0.0-pre.16
* @polymer/paper-styles#^3.0.0-pre.16
paper-icon-button version 3.0.0-pre.17
### Dependencies
* @polymer/polymer#^3.0.0-pre.13
* @polymer/iron-icon#^3.0.0-pre.17
* @polymer/paper-behaviors#^3.0.0-pre.17
* @polymer/paper-styles#^3.0.0-pre.17
paper-icon-button version 3.0.0-pre.18
### Dependencies
* @polymer/polymer#^3.0.0
* @polymer/iron-icon#^3.0.0-pre.18
* @polymer/paper-behaviors#^3.0.0-pre.18
* @polymer/paper-styles#^3.0.0-pre.18
paper-icon-button version 3.0.0-pre.19
### Dependencies
* @polymer/polymer#^3.0.0
* @polymer/iron-icon#^3.0.0-pre.19
* @polymer/paper-behaviors#^3.0.0-pre.19
* @polymer/paper-styles#^3.0.0-pre.19
paper-icon-button version 3.0.0-pre.20
### Dependencies
* @polymer/polymer#^3.0.0
* @polymer/iron-icon#^3.0.0-pre.20
* @polymer/paper-behaviors#^3.0.0-pre.20
* @polymer/paper-styles#^3.0.0-pre.20
paper-icon-button version 3.0.0-pre.21
### Dependencies
* @polymer/polymer#^3.0.0
* @polymer/iron-icon#^3.0.0-pre.21
* @polymer/paper-behaviors#^3.0.0-pre.21
* @polymer/paper-styles#^3.0.0-pre.21
paper-icon-button version 3.0.0-pre.22
### Dependencies
* @polymer/polymer#^3.0.0
* @polymer/iron-icon#^3.0.0-pre.20
* @polymer/paper-behaviors#^3.0.0-pre.20
* @polymer/paper-styles#^3.0.0-pre.20
paper-icon-button version 3.0.0-pre.23
### Dependencies
* @polymer/polymer#^3.0.0
* @polymer/iron-icon#^3.0.0-pre.22
* @polymer/paper-behaviors#^3.0.0-pre.23
* @polymer/paper-styles#^3.0.0-pre.22
paper-icon-button version 3.0.0-pre.24
### Dependencies
* @polymer/polymer#^3.0.0
* @polymer/iron-icon#^3.0.0-pre.22
* @polymer/paper-behaviors#^3.0.0-pre.23
* @polymer/paper-styles#^3.0.0-pre.22
paper-icon-button version 3.0.0-pre.25
### Dependencies
* @polymer/polymer#^3.0.0
* @polymer/iron-icon#^3.0.0-pre.24
* @polymer/paper-behaviors#^3.0.0-pre.25
* @polymer/paper-styles#^3.0.0-pre.24
paper-icon-button version 3.0.0-pre.26
### Dependencies
* @polymer/polymer#^3.0.0
* @polymer/iron-icon#^3.0.0-pre.25
* @polymer/paper-behaviors#^3.0.0-pre.26
* @polymer/paper-styles#^3.0.0-pre.25
paper-icon-button version 3.0.0
### Dependencies
* @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
paper-icon-button version 3.0.1
### Dependencies
* @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
paper-icon-button version 2.2.1
### Dependencies
* polymer#Polymer/polymer#1.9 - 2
* iron-icon#PolymerElements/iron-icon#1 - 2
* paper-behaviors#PolymerElements/paper-behaviors#1 - 2
* paper-styles#PolymerElements/paper-styles#1 - 2
paper-icon-button version 3.0.2
### Dependencies
* @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