Skip to content
This repository has been archived by the owner on Mar 13, 2018. It is now read-only.

Commit

Permalink
Update core-icon API docs
Browse files Browse the repository at this point in the history
Related to #19.
  • Loading branch information
Arthur Evans committed Sep 3, 2014
1 parent 4c91899 commit bc213f3
Showing 1 changed file with 22 additions and 5 deletions.
27 changes: 22 additions & 5 deletions core-icon.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
-->
<!--
The `core-icon` element displays an icon. By default an icon renders as 24px square.
The `core-icon` element displays an icon. By default an icon renders as a 24px square.
Example using src:
Expand All @@ -25,18 +25,35 @@
}
</style>
Example using icon from default iconset:
The core elements include several sets of icons.
To use the default set of icons, import `core-icons.html` and use the `icon` attribute to specify an icon:
Example of using an icon from the default iconset:
&lt;!-- import default iconset and core-icon --&gt;
<link rel="import" href="/components/core-icons/core-icons.html">
<core-icon icon="menu"></core-icon>
To use a different built-in set of icons, import `core-icons/<iconset>-icons.html`, and
specify the icon as `<iconset>:<icon>`. For example:
&lt;!-- import communication iconset and core-icon --&gt;
<link rel="import" href="/components/core-icons/communication-icons.html">
<core-icon icon="communication:email"></core-icon>
You can also create custom icon sets of bitmap or SVG icons.
Example using icon `cherry` from custom iconset `fruit`:
Example of using an icon named `cherry` from a custom iconset with the ID `fruit`:
<core-icon icon="fruit:cherry"></core-icon>
See [core-iconset](#core-iconset) and [core-iconset-svg](#core-iconset-svg) for more information about
how to use a custom iconset.
how to create a custom iconset.
See [core-icons](http://www.polymer-project.org/components/core-icons/demo.html) for the default set of icons. To use the default set of icons you'll need to include an import for `core-icons.html`. To use a different built-in set of icons, you'll need to include an import for `core-icons/iconsets/<iconset>.html`.
See [core-icons](http://www.polymer-project.org/components/core-icons/demo.html) for the default set of icons.
@group Polymer Core Elements
@element core-icon
Expand Down

0 comments on commit bc213f3

Please sign in to comment.