# @polymer/paper-icon-button
> A material design icon button
Latest version **3.0.2** (published 2019-01-16) · BSD-3-Clause license · 0 weekly downloads
## Install
```sh
npm install @polymer/paper-icon-button
pnpm add @polymer/paper-icon-button
yarn add @polymer/paper-icon-button
bun add @polymer/paper-icon-button
```
## Health
**Score 15/100 (F)** — status: abandoned.
Positive: no vulnerabilities.
Warnings: low downloads; no types; no esm support.
Negative: abandoned; low maintenance score.
## Facts
| | |
|---|---|
| Version | 3.0.2 |
| Published | 2019-01-16 |
| First published | 2016-02-02 |
| Weekly downloads | 0 |
| License | BSD-3-Clause |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 30.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 42 |
| Author | The Polymer Authors |
| Maintainers | aomarks, azakus, bicknellr, emarquez, justinfagnani, keanulee, notwaldorf, polymer-devs, samli, sorvell, tvanderlippe, usergenic |
| Keywords | web-components, polymer, button, icon, control |
## Links
- npm: https://www.npmjs.com/package/@polymer/paper-icon-button
- Repository: https://github.com/PolymerElements/paper-icon-button
- Homepage: https://github.com/PolymerElements/paper-icon-button#readme
- Issues: https://github.com/PolymerElements/paper-icon-button/issues
- npm.io page: https://npm.io/package/@polymer/paper-icon-button
## Dependencies (4)
- [@polymer/polymer](https://npm.io/package/@polymer/polymer.md) ^3.0.0
- [@polymer/iron-icon](https://npm.io/package/@polymer/iron-icon.md) ^3.0.0-pre.26
- [@polymer/paper-styles](https://npm.io/package/@polymer/paper-styles.md) ^3.0.0-pre.26
- [@polymer/paper-behaviors](https://npm.io/package/@polymer/paper-behaviors.md) ^3.0.0-pre.27
## Alternatives
- [@fortawesome/react-fontawesome](https://npm.io/package/@fortawesome/react-fontawesome.md) — 2.2M weekly downloads
- [roboto-fontface](https://npm.io/package/roboto-fontface.md) — 196.0K weekly downloads
- [@react-native-vector-icons/common](https://npm.io/package/@react-native-vector-icons/common.md) — 150.4K weekly downloads
- [@procore/core-icons](https://npm.io/package/@procore/core-icons.md) — 4.6K weekly downloads
- [@react-md/material-icons](https://npm.io/package/@react-md/material-icons.md) — 1.6K weekly downloads
## Recent versions
- 3.0.2 (latest) — 2019-01-16
- 3.0.0-pre.20 (next) — 2018-06-23
- 1.1.4-pre.3 (preview) — 2017-01-24
- 3.0.1 — 2018-09-14
- 3.0.0 — 2018-09-13
- 3.0.0-pre.26 — 2018-09-12
- 3.0.0-pre.25 — 2018-08-29
- 3.0.0-pre.24 — 2018-08-29
- 3.0.0-pre.23 — 2018-08-25
- 3.0.0-pre.22 — 2018-08-25
- 3.0.0-pre.21 — 2018-06-23
- 3.0.0-pre.19 — 2018-05-09
- 3.0.0-pre.18 — 2018-05-09
- 3.0.0-pre.17 — 2018-05-08
- 3.0.0-pre.16 — 2018-05-04
- … 18 more at https://npm.io/package/@polymer/paper-icon-button/versions
## README
[](https://www.npmjs.com/package/@polymer/paper-icon-button)
[](https://travis-ci.org/PolymerElements/paper-icon-button)
[](https://webcomponents.org/element/@polymer/paper-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](https://www.webcomponents.org/element/@polymer/paper-icon-button),
[Demo](https://www.webcomponents.org/element/@polymer/paper-icon-button/demo/demo/index.html).
## Usage
### Installation
```
npm install --save @polymer/paper-icon-button
```
### In an html file
```html
```
### In a Polymer 3 element
```js
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`
`;
}
}
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
```sh
git clone https://github.com/PolymerElements/paper-icon-button
cd paper-icon-button
npm install
npm install -g polymer-cli
```
### Running the demo locally
```sh
polymer serve --npm
open http://127.0.0.1:/demo/
```
### Running the tests
```sh
polymer test --npm
```
---
_Source: https://npm.io/package/@polymer/paper-icon-button · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._