polymer-elements-typings
v1.0.1
Published
.d.ts definitions for [PolymerElements](https://github.com/PolymerElements)
Downloads
7
Readme
polymer-elements-typings
Type definitions for PolymerElements. For use with TypeScript. Should also be compatible with Flow.
Usage
In Your Web App
To learn more about how to develop Polymer elements in TypeScript refer to PolymerTS or Eric Bidelman's article on Building web components using ES6 classes.
npm install --save-dev polymer-elements-typings
ln -s node_modules/polymer-elements-typings/typings typings/polymer-elements
Then, at the top of each .ts
file, add a reference to each definition file you require:
/// <reference path="typings/polymer-elements/paper-behaviors/paper-ripple-behavior.d.ts"/>
@component('ts-element')
@behavior(Polymer['PaperRippleBehavior'])
class TsElement extends polymer.Base implements Polymer.PaperRippleBehavior
{
// stand-in properties for behavior mixins
noink: boolean = false;
ensureRipple: (optTriggeringEvent?: Event) => void;
getRipple: () => paper.PaperRipple;
hasRipple: () => boolean;
handleClick(e:Event)
{
this.greet = "Holà";
this.fire("greet-event");
this.ensureRipple(e);
}
}
Generation of .d.ts files
This should only be necessary when the Polymer team release a new update to any of the elements.
Installation
npm install # (only required for `gulp polymer-to-typescript`)
bower install
polymer-to-typescript
Simply run gulp
and the PolymerElements under bower_components
will be converted for polymer-ts and then .d.ts
files will be generated into typings
.
generator-polymerts
Another approach is to use generator-polymerts to create .d.ts
files from the PolymerElements source directly:
./generate-tsd.sh