Generator-angular-polymer NPM

Angular-Polymer Generator

This project bridges the gap between Angular and Polymer 1.x. Therefore generator-angular-polymer is a Yeoman generator which creates directives to deal with issues between current Angular and Polymer versions.

Note: Parts of this project base on angular-polymer.

Getting Started

Configure the generator for your project setup (see Configuration).
Run yo angular-polymer to create directives.
Integrate the created directives in the existing Angular project. They are stored within the configured out-dir.

Demo App

The demo project shows an example usage of the generator with Angular 4 and angular-cli.

Installation

This project is part of the Yeoman environment and requires a current Yeoman version installed. To install Yeoman run:

npm install -g yo.

For more informations about Yeoman see the Yeoman documentation.

Afterwards, install the generator globally with:

npm install -g generator-angular-polymer

or local with:

npm install --save-dev generator-angular-polymer

Configuration

The generator's configuration is stored within the Yeoman configuration file (.yo-rc.json). Run yo angular-polymer:init inside the root directory of your project which creates an initial configuration of the generator.

The configuration file is located in the project's root directory and provides the following configuration parameters:

Parameter	Function
html-imports	List of all paths which contain Polymer elements.
out-dir	Relative path to a directory in which the generatered directives will be stored.
excluded	List of all elements that should not be part of the generation process.

Best Practices

Use "Wrapper Files"

It's helpful to use one file which includes the Polymer elements into the Angular application and configures the generator, too. Since the file paths of Polymer elements don't exist twice, these wrapper files minimalize the configuration overhead.

Use the global `POLYMER_ELEMENTS` constant

It's possible but not to recommended to separately include Polymer elements instead of using the global POLYMER_ELEMENTS constant. This constant encapsulates all necessary files and gets recreated with every generator run.