@vaadin/angular2-polymer

Angular 2 support for Polymer elements

Usage no npm install needed!

<script type="module">
  import vaadinAngular2Polymer from 'https://cdn.skypack.dev/@vaadin/angular2-polymer';
</script>

README

Version

Angular2-Polymer

angular2-polymer is a directive factory that aims at bridging the gaps between using Polymer based Web Components in Angular 2 applications.

import { NgModule, CUSTOM_ELEMENTS_SCHEMA, Component } from '@angular/core';
import { BrowserModule } from '@angular/platform-browser';
import { PolymerElement } from '@vaadin/angular2-polymer';

@NgModule({
  imports: [ BrowserModule ],
  declarations: [
    AppComponent,
    PolymerElement('paper-input'),
    PolymerElement('vaadin-combo-box')
  ],
  bootstrap: [ AppComponent ],
  schemas: [ CUSTOM_ELEMENTS_SCHEMA ]
})
export class AppModule { }

@Component({
  selector: 'app-component',
  template: `
    <paper-input [(value)]="myValue"></paper-input>
    <vaadin-combo-box [(value)]="myValue" [items]="myItems"></vaadin-combo-box>
  `
})
class AppComponent {
  myValue = 'A';
  myItems = ['A', 'B', 'C'];
}

Getting started

See the overview for a quick start.

See the tutorial for complete instructions on how to use angular2-polymer and how to build a working application with Angular 2 data binding and routes.

If you are using Angular CLI in your project, see the specific document for projects created with the ng command line utility.

Demo app

The Expense Manager demo is an example of a real world application built using Angular 2 and Polymer web components.

Where to get Polymer web components

For high quality Polymer web components, see Vaadin Elements and the Polymer Element Catalog.

Contributing

See the contribution instructions which apply to this project as well.

Development

Familiarize yourself with the code and try to follow the same syntax conventions to make it easier for us to accept your pull requests.

Getting the Code

  1. Clone the angular2-polymer project:
$ git clone https://github.com/vaadin/angular2-polymer.git
$ cd angular2-polymer
  1. Install dependencies. We assume that you have already installed npm in your system.
$ npm install

Running Tests

For running the tests you need Bower installed.

Then, you can download all bower dependencies needed by the Tests.

$ bower install

Finally, you can run the tests by typing:

$ npm test

License

Apache License 2.0