@polymer/iron-icons
Version:
A set of icons for use with iron-icon
84 lines (62 loc) • 2 kB
Markdown
[](https://www.npmjs.com/package/@polymer/iron-icons)
[](https://travis-ci.org/PolymerElements/iron-icons)
[](https://webcomponents.org/element/@polymer/iron-icons)
## <iron-icons>
`iron-icons` is a utility import that includes the definition for the
`iron-icon` element, `iron-iconset-svg` element, as well as an import for the
default icon set.
See: [Documentation](https://www.webcomponents.org/element/@polymer/iron-icons),
[Demo](https://www.webcomponents.org/element/@polymer/iron-icons/demo/demo/index.html).
## Usage
### Installation
```
npm install --save @polymer/iron-icons
```
### In an HTML file
```html
<html>
<head>
<script type="module">
import '@polymer/iron-icon/iron-icon.js';
import '@polymer/iron-icons/iron-icons.js';
</script>
</head>
<body>
<iron-icon icon="search"></iron-icon>
</body>
</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';
import '@polymer/iron-icons/iron-icons.js';
class ExampleElement extends PolymerElement {
static get template() {
return html`
<iron-icon icon="search"></iron-icon>
`;
}
}
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-icons
cd iron-icons
npm install
npm install -g polymer-cli
```
### Running the demo locally
```sh
polymer serve --npm
open http://127.0.0.1:<port>/demo/
```
### Running the tests
```sh
polymer test --npm
```