Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(1068)

Unified Diff: third_party/polymer/v0_8/components/iron-iconset/README.md

Issue 1162563004: Upgrade to 1.0 and switch clients to dom-repeat where needed. (Closed) Base URL: https://chromium.googlesource.com/chromium/src.git@master
Patch Set: Fix a layout import and remove the gzipped webanimation in reproduce.sh Created 5 years, 7 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View side-by-side diff with in-line comments
Download patch
Index: third_party/polymer/v0_8/components/iron-iconset/README.md
diff --git a/third_party/polymer/v0_8/components/iron-iconset/README.md b/third_party/polymer/v0_8/components/iron-iconset/README.md
index 3f46cf5b8ce817cb7a57920b12903fe2cf3a7bba..53a245b52621c5106b14c288b0aa86c67742fca3 100644
--- a/third_party/polymer/v0_8/components/iron-iconset/README.md
+++ b/third_party/polymer/v0_8/components/iron-iconset/README.md
@@ -1,4 +1,51 @@
iron-iconset
============
-See the [component page](http://polymer-project.org/docs/elements/iron-elements.html#iron-iconset) for more information.
+The `iron-iconset` element allows users to define their own icon sets.
+The `src` property specifies the url of the icon image. Multiple icons may
+be included in this image and they may be organized into rows.
+The `icons` property is a space separated list of names corresponding to the
+icons. The names must be ordered as the icons are ordered in the icon image.
+Icons are expected to be square and are the size specified by the `size`
+property. The `width` property corresponds to the width of the icon image
+and must be specified if icons are arranged into multiple rows in the image.
+
+All `iron-iconset` elements are available for use by other `iron-iconset`
+elements via a database keyed by id. Typically, an element author that wants
+to support a set of custom icons uses a `iron-iconset` to retrieve
+and use another, user-defined iconset.
+
+Example:
+
+```html
+<iron-iconset id="my-icons" src="my-icons.png" width="96" size="24"
+ icons="location place starta stopb bus car train walk">
+</iron-iconset>
+```
+
+This will automatically register the icon set "my-icons" to the iconset
+database. To use these icons from within another element, make a
+`iron-iconset` element and call the `byId` method to retrieve a
+given iconset. To apply a particular icon to an element, use the
+`applyIcon` method. For example:
+
+```javascript
+iconset.applyIcon(iconNode, 'car');
+```
+
+Themed icon sets are also supported. The `iron-iconset` can contain child
+`property` elements that specify a theme with an offsetX and offsetY of the
+theme within the icon resource. For example.
+
+```html
+<iron-iconset id="my-icons" src="my-icons.png" width="96" size="24"
+ icons="location place starta stopb bus car train walk">
+ <property theme="special" offsetX="256" offsetY="24"></property>
+</iron-iconset>
+```
+
+Then a themed icon can be applied like this:
+
+```javascript
+iconset.applyIcon(iconNode, 'car', 'special');
+```

Powered by Google App Engine
This is Rietveld 408576698