-
Notifications
You must be signed in to change notification settings - Fork 39
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add TypeScript declarations to iron-icon. (#123)
* Generate minimal package.json from bower.json * Update and/or configure type declarations.
- Loading branch information
Showing
5 changed files
with
1,103 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,3 @@ | ||
bower_components* | ||
bower-*.json | ||
node_modules |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,107 @@ | ||
/** | ||
* DO NOT EDIT | ||
* | ||
* This file was automatically generated by | ||
* https://github.com/Polymer/gen-typescript-declarations | ||
* | ||
* To modify these typings, edit the source file(s): | ||
* iron-icon.html | ||
*/ | ||
|
||
/// <reference path="../polymer/types/polymer.d.ts" /> | ||
/// <reference path="../iron-meta/iron-meta.d.ts" /> | ||
/// <reference path="../iron-flex-layout/iron-flex-layout.d.ts" /> | ||
|
||
/** | ||
* The `iron-icon` element displays an icon. By default an icon renders as a 24px square. | ||
* | ||
* Example using src: | ||
* | ||
* <iron-icon src="star.png"></iron-icon> | ||
* | ||
* Example setting size to 32px x 32px: | ||
* | ||
* <iron-icon class="big" src="big_star.png"></iron-icon> | ||
* | ||
* <style is="custom-style"> | ||
* .big { | ||
* --iron-icon-height: 32px; | ||
* --iron-icon-width: 32px; | ||
* } | ||
* </style> | ||
* | ||
* The iron elements include several sets of icons. | ||
* To use the default set of icons, import `iron-icons.html` and use the `icon` attribute to specify an icon: | ||
* | ||
* <link rel="import" href="/components/iron-icons/iron-icons.html"> | ||
* | ||
* <iron-icon icon="menu"></iron-icon> | ||
* | ||
* To use a different built-in set of icons, import the specific `iron-icons/<iconset>-icons.html`, and | ||
* specify the icon as `<iconset>:<icon>`. For example, to use a communication icon, you would | ||
* use: | ||
* | ||
* <link rel="import" href="/components/iron-icons/communication-icons.html"> | ||
* | ||
* <iron-icon icon="communication:email"></iron-icon> | ||
* | ||
* You can also create custom icon sets of bitmap or SVG icons. | ||
* | ||
* Example of using an icon named `cherry` from a custom iconset with the ID `fruit`: | ||
* | ||
* <iron-icon icon="fruit:cherry"></iron-icon> | ||
* | ||
* See [iron-iconset](iron-iconset) and [iron-iconset-svg](iron-iconset-svg) for more information about | ||
* how to create a custom iconset. | ||
* | ||
* See the [iron-icons demo](iron-icons?view=demo:demo/index.html) to see the icons available | ||
* in the various iconsets. | ||
* | ||
* To load a subset of icons from one of the default `iron-icons` sets, you can | ||
* use the [poly-icon](https://poly-icon.appspot.com/) tool. It allows you | ||
* to select individual icons, and creates an iconset from them that you can | ||
* use directly in your elements. | ||
* | ||
* ### Styling | ||
* | ||
* The following custom properties are available for styling: | ||
* | ||
* Custom property | Description | Default | ||
* ----------------|-------------|---------- | ||
* `--iron-icon` | Mixin applied to the icon | {} | ||
* `--iron-icon-width` | Width of the icon | `24px` | ||
* `--iron-icon-height` | Height of the icon | `24px` | ||
* `--iron-icon-fill-color` | Fill color of the svg icon | `currentcolor` | ||
* `--iron-icon-stroke-color` | Stroke color of the svg icon | none | ||
*/ | ||
interface IronIconElement extends Polymer.Element { | ||
|
||
/** | ||
* The name of the icon to use. The name should be of the form: | ||
* `iconset_name:icon_name`. | ||
*/ | ||
icon: string|null|undefined; | ||
|
||
/** | ||
* The name of the theme to used, if one is specified by the | ||
* iconset. | ||
*/ | ||
theme: string|null|undefined; | ||
|
||
/** | ||
* If using iron-icon without an iconset, you can set the src to be | ||
* the URL of an individual icon image file. Note that this will take | ||
* precedence over a given icon attribute. | ||
*/ | ||
src: string|null|undefined; | ||
_meta: Polymer.IronMeta; | ||
_DEFAULT_ICONSET: string; | ||
_iconChanged(icon: any): void; | ||
_srcChanged(src: any): void; | ||
_usesIconset(): any; | ||
_updateIcon(): void; | ||
} | ||
|
||
interface HTMLElementTagNameMap { | ||
"iron-icon": IronIconElement; | ||
} |
Oops, something went wrong.