diff options
Diffstat (limited to 'catapult/third_party/polymer/components/iron-iconset-svg/README.md')
| -rw-r--r-- | catapult/third_party/polymer/components/iron-iconset-svg/README.md | 56 |
1 files changed, 56 insertions, 0 deletions
diff --git a/catapult/third_party/polymer/components/iron-iconset-svg/README.md b/catapult/third_party/polymer/components/iron-iconset-svg/README.md new file mode 100644 index 00000000..971ab0c7 --- /dev/null +++ b/catapult/third_party/polymer/components/iron-iconset-svg/README.md @@ -0,0 +1,56 @@ + +<!--- + +This README is automatically generated from the comments in these files: +iron-iconset-svg.html + +Edit those files, and our readme bot will duplicate them over here! +Edit this file, and the bot will squash your changes :) + +The bot does some handling of markdown. Please file a bug if it does the wrong +thing! https://github.com/PolymerLabs/tedium/issues + +--> + +[](https://travis-ci.org/PolymerElements/iron-iconset-svg) + +_[Demo and API docs](https://elements.polymer-project.org/elements/iron-iconset-svg)_ + + +##<iron-iconset-svg> + +The `iron-iconset-svg` element allows users to define their own icon sets +that contain svg icons. The svg icon elements should be children of the +`iron-iconset-svg` element. Multiple icons should be given distinct id's. + +Using svg elements to create icons has a few advantages over traditional +bitmap graphics like jpg or png. Icons that use svg are vector based so +they are resolution independent and should look good on any device. They +are stylable via css. Icons can be themed, colorized, and even animated. + +Example: + +```html +<iron-iconset-svg name="my-svg-icons" size="24"> + <svg> + <defs> + <g id="shape"> + <rect x="12" y="0" width="12" height="24" /> + <circle cx="12" cy="12" r="12" /> + </g> + </defs> + </svg> +</iron-iconset-svg> +``` + +This will automatically register the icon set "my-svg-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 inside an +element use the `applyIcon` method. For example: + +```javascript +iconset.applyIcon(iconNode, 'car'); +``` + + |