README.md
1
2<!---
3
4This README is automatically generated from the comments in these files:
5iron-icons.html
6
7Edit those files, and our readme bot will duplicate them over here!
8Edit this file, and the bot will squash your changes :)
9
10The bot does some handling of markdown. Please file a bug if it does the wrong
11thing! https://github.com/PolymerLabs/tedium/issues
12
13-->
14
15[](https://travis-ci.org/PolymerElements/iron-icons)
16
17_[Demo and API docs](https://elements.polymer-project.org/elements/iron-icons)_
18
19
20##<iron-icons>
21
22`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.
23
24The `iron-icons` directory also includes imports for additional icon sets that can be loaded into your project.
25
26Example loading icon set:
27
28```html
29<link rel="import" href="../iron-icons/maps-icons.html">
30```
31
32To use an icon from one of these sets, first prefix your `iron-icon` with the icon set name, followed by a colon, ":", and then the icon id.
33
34Example using the directions-bus icon from the maps icon set:
35
36```html
37<iron-icon icon="maps:directions-bus"></iron-icon>
38```
39
40To load a subset of icons from one of the default `iron-icons` sets, you can
41use the [poly-icon](https://poly-icon.appspot.com/) tool. It allows you
42to select individual icons, and creates an iconset from them that you can
43use directly in your elements.
44
45See [iron-icon](./iron-icon) for more information about working with icons.
46
47See [iron-iconset](./iron-iconset) and [iron-iconset-svg](./iron-iconset-svg) for more information about how to create a custom iconset.
48
49
50
){kind=link}