# @polymer/iron-icon
> An element that supports displaying an icon
Latest version **3.0.1** (published 2018-09-14) · BSD-3-Clause license · 0 weekly downloads
## Install
```sh
npm install @polymer/iron-icon
pnpm add @polymer/iron-icon
yarn add @polymer/iron-icon
bun add @polymer/iron-icon
```
## 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.1 |
| Published | 2018-09-14 |
| First published | 2016-02-02 |
| Weekly downloads | 0 |
| License | BSD-3-Clause |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 21.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 39 |
| Author | The Polymer Authors |
| Maintainers | aomarks, azakus, bicknellr, emarquez, justinfagnani, keanulee, notwaldorf, polymer-devs, samli, sorvell, usergenic |
| Keywords | web-components, polymer, icon |
## Links
- npm: https://www.npmjs.com/package/@polymer/iron-icon
- Repository: https://github.com/PolymerElements/iron-icon
- Homepage: https://github.com/PolymerElements/iron-icon#readme
- Issues: https://github.com/PolymerElements/iron-icon/issues
- npm.io page: https://npm.io/package/@polymer/iron-icon
## Dependencies (3)
- [@polymer/polymer](https://npm.io/package/@polymer/polymer.md) ^3.0.0
- [@polymer/iron-meta](https://npm.io/package/@polymer/iron-meta.md) ^3.0.0-pre.26
- [@polymer/iron-flex-layout](https://npm.io/package/@polymer/iron-flex-layout.md) ^3.0.0-pre.26
## 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.1 (latest) — 2018-09-14
- 3.0.0-pre.20 (next) — 2018-06-23
- 1.0.12-pre.3 (preview) — 2017-01-24
- 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
- 3.0.0-pre.15 — 2018-05-02
- … 17 more at https://npm.io/package/@polymer/iron-icon/versions
## README
[](https://www.npmjs.com/package/@polymer/iron-icon)
[](https://travis-ci.org/PolymerElements/iron-icon)
[](https://webcomponents.org/element/@polymer/iron-icon)
## <iron-icon>
The `iron-icon` element displays an icon. By default an icon renders as a 24px
square.
See: [Documentation](https://www.webcomponents.org/element/@polymer/iron-icon),
[Demo](https://www.webcomponents.org/element/@polymer/iron-icon/demo/demo/index.html).
## Usage
### Installation
```
npm install --save @polymer/iron-icon
```
### In an HTML file
```html
```
### In a Polymer 3 element
```js
import {PolymerElement} from '@polymer/polymer/polymer-element.js';
import {html} from '@polymer/polymer/lib/utils/html-tag.js';
import '@polymer/iron-icon/iron-icon.js';
class ExampleElement extends PolymerElement {
static get template() {
return html`
`;
}
}
customElements.define('example-element', ExampleElement);
```
## 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/iron-icon
cd iron-icon
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/iron-icon · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._