Repository: vaadin/angular2-polymer Branch: master Commit: fd8c2d9a9ba6 Files: 34 Total size: 143.0 KB Directory structure: gitextract_9htu4niu/ ├── .gitignore ├── .npmignore ├── LICENSE ├── README.md ├── bower.json ├── circle.yml ├── docs/ │ ├── api.adoc │ ├── best-practices.adoc │ ├── ng-cli-webpack.adoc │ ├── overview.adoc │ ├── tutorial/ │ │ ├── creating-project.adoc │ │ ├── dependencies.adoc │ │ ├── hero-editor.adoc │ │ ├── introduction.adoc │ │ ├── layout.adoc │ │ ├── list-heroes.adoc │ │ ├── polymer.adoc │ │ └── wrap-up.adoc │ └── tutorial-index.adoc ├── index.spec.ts ├── index.ts ├── karma.conf.js ├── package.json ├── src/ │ ├── polymer-element.spec.ts │ ├── polymer-element.ts │ ├── polymer-module.spec.ts │ ├── polymer-module.ts │ ├── renderer/ │ │ ├── polymer-renderer.spec.ts │ │ ├── polymer-renderer.ts │ │ └── shared-custom-styles-host.ts │ └── test-element.html ├── system.config.js ├── tsconfig.json └── tslint.json ================================================ FILE CONTENTS ================================================ ================================================ FILE: .gitignore ================================================ *.js !karma.conf.js !system.config.js *.d.ts # Created by https://www.gitignore.io/api/node,bower,typings ### Node ### # Logs logs *.log npm-debug.log* # Runtime data pids *.pid *.seed # Directory for instrumented libs generated by jscoverage/JSCover lib-cov # Coverage directory used by tools like istanbul coverage # nyc test coverage .nyc_output # Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files) .grunt # node-waf configuration .lock-wscript # Compiled binary addons (http://nodejs.org/api/addons.html) build/Release # Dependency directories node_modules jspm_packages # Optional npm cache directory .npm # Optional REPL history .node_repl_history ### Bower ### bower_components .bower-cache .bower-registry .bower-tmp ### IntelliJ ### .idea angular-polymer.iml ================================================ FILE: .npmignore ================================================ # Source files bower.json tsconfig.json tslint.json typings/ typings.json *.ts !*.d.ts # Tests and testing setup *.html *.spec.js *.spec.ts *.spec.d.ts system.config.js karma.conf.js circle.yml # Docs docs/ # Created by https://www.gitignore.io/api/node,bower,typings ### Node ### # Logs logs *.log npm-debug.log* # Runtime data pids *.pid *.seed # Directory for instrumented libs generated by jscoverage/JSCover lib-cov # Coverage directory used by tools like istanbul coverage # nyc test coverage .nyc_output # Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files) .grunt # node-waf configuration .lock-wscript # Compiled binary addons (http://nodejs.org/api/addons.html) build/Release # Dependency directories node_modules jspm_packages # Optional npm cache directory .npm # Optional REPL history .node_repl_history ### Bower ### bower_components .bower-cache .bower-registry .bower-tmp ### Typings ### ## Ignore downloaded typings typings ================================================ FILE: LICENSE ================================================ Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS Copyright 2016 Vaadin Ltd. Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. ================================================ FILE: README.md ================================================ [![CircleCI](https://img.shields.io/circleci/project/github/platosha/angular-polymer.svg)](https://circleci.com/gh/platosha/angular-polymer) [![Version](https://img.shields.io/npm/v/angular-polymer.svg)](https://www.npmjs.com/package/angular-polymer) # Angular-Polymer `angular-polymer` is a directive factory that aims at bridging the gaps between using [Polymer](https://www.polymer-project.org) based Web Components in [Angular](https://angular.io/) applications. > Note: Currently Angular-Polymer only works with Angular 2.x, or Angular-CLI 1.0.0-rc.2 and lower. > Work is being done to upgrade the library to work the latest Angular & CLI. [Want to help Contribute?](https://github.com/platosha/angular-polymer/issues/123) **In case you are using Angular 4+ and Polymer 2+** you might want to check out https://github.com/hotforfeature/origami --- ```typescript import { NgModule, CUSTOM_ELEMENTS_SCHEMA, Component } from '@angular/core'; import { PolymerModule, PolymerElement } from '@vaadin/angular2-polymer'; @NgModule({ imports: [ PolymerModule ], declarations: [ AppComponent, PolymerElement('paper-input'), PolymerElement('vaadin-combo-box') ], bootstrap: [ AppComponent ], schemas: [ CUSTOM_ELEMENTS_SCHEMA ] }) export class AppModule { } @Component({ selector: 'app-component', template: ` ` }) class AppComponent { myValue = 'A'; myItems = ['A', 'B', 'C']; } ``` ## Getting started See the overview for a [quick start](https://github.com/platosha/angular-polymer/blob/master/docs/overview.adoc#quick-start). See the [tutorial](https://github.com/platosha/angular-polymer/blob/master/docs/tutorial-index.adoc) for complete instructions on how to use `angular-polymer` and how to build a working application with Angular data binding and routes. If you are using [Webpack](https://webpack.github.io/) in your project, see the specific [document](https://github.com/platosha/angular-polymer/blob/master/docs/ng-cli-webpack.adoc) on how to build angular-polymer apps with webpack. ## Demo app The Expense Manager demo is an example of a real world application built using Angular and Polymer web components. - [Live demo](http://demo.vaadin.com/expense-manager-ng) - [Source code](https://github.com/vaadin/expense-manager-ng2-demo) ## Where to get Polymer web components For high quality Polymer web components, see the [Webcomponents Element Catalog](https://www.webcomponents.org/) and [Vaadin Elements](https://vaadin.com/elements). ## 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. Discuss / exchange ideas and ask questions here: https://polymer.slack.com/messages/polymer-angular/ ### Getting the Code 1. Clone the angular-polymer project: ```shell $ git clone https://github.com/platosha/angular-polymer.git $ cd angular-polymer ``` 2. Install dependencies. We assume that you have already installed `npm` in your system. ```shell $ npm install ``` ### Running Tests For running the tests you need [Bower](http://bower.io) installed. Then, you can download all bower dependencies needed by the Tests. ```shell $ bower install ``` Finally, you can run the tests by typing: ```shell $ npm test ``` Optionally, you can watch for the source changes and keep the tests running automatically: ```shell $ npm run test:w ``` ## License Apache License 2.0 ================================================ FILE: bower.json ================================================ { "name": "angular2-polymer", "description": "Angular 2 support for Polymer elements", "main": "index.js", "authors": [ "Vaadin Ltd" ], "license": "Apache 2.0", "homepage": "https://github.com/vaadin/angular2-polymer", "moduleType": [], "private": false, "ignore": [ "**/.*", "node_modules", "bower_components", "test", "tests" ], "devDependencies": { "polymer": "Polymer/polymer#^1.4.0", "iron-form-element-behavior": "PolymerElements/iron-form-element-behavior#^1.0.6", "paper-checkbox": "PolymerElements/paper-checkbox#^1.3.0" } } ================================================ FILE: circle.yml ================================================ machine: node: version: 6.9.1 dependencies: override: - npm install - npm run bower install cache_directories: - bower_components compile: override: - npm run lint ================================================ FILE: docs/api.adoc ================================================ --- title: API Reference order: 4 layout: page --- [[vaadin-angular2-polymer.api]] = Angular2-Polymer API This package consists of one generic Angular 2 directive factory method named [classname]#PolymerElement#, which is able to handle any Polymer element for easy integrating on Angular apps. == Features The [classname]#PolymerElement# is composed of a set of low level directives which would be added to the module dynamically. `changeEventsAdapterDirective`:: This directive configures all the the public [propertyname]#properties#, that notify for their value change in a Polymer element, to be an Angular 2 link:https://angular.io/docs/js/latest/api/core/DirectiveMetadata-class.html+++#+++!+++#+++outputs-anchor[output]. So as any change made in a property in the polymer side, will be propagated to the Angular 2 parent component. `notifyForDiffersDirective`:: Configures all the public [propertyname]#properties# in a Polymer element to be an Angular 2 link:https://angular.io/docs/js/latest/api/core/DirectiveMetadata-class.html+++#+++!+++#+++inputs-anchor[input]. It allows to notify changes from the Angular side to Polymer. It supports primitive types, as well as both Array and Object properties, but not its children. If you want to notify nested object changes, you can still do it by calling the Polymer's [methodname]#notifyPath# method on the element. `formElementDirective`:: If the element has the Polymer Form Element Behavior, this directive is added to the module, and it configures the element to be compatible with the Angular 2 `ngForm`. `validationDirective`:: It is another directive added in the case of the element has the Polymer Form Element Behavior. It sets the Polymer [propertyname]#invalid# flag based on the Angular 2 `ngControl` state. `reloadConfigurationDirective`:: This directive is added to those Polymer elements that need to run a configuration function after they are initialized. It is added if the element has the [methodname]#isInitialized# and the [methodname]#reloadConfiguration# methods in its prototype. == Usage In order to use the [classname]#PolymerElement# in the [propertyname]#declarations# block of your [classname]#NgModule#, you have to import it as is shown in the example below. The only public API is the [classname]#PolymerElement(tagName: string): Array# factory method. The argument [propertyname]#tagName# is mandatory, and must match the tag name of the Polymer element. The factory returns the set of necessary directives for the given Polymer element. Hence, you have to add the [classname]#PolymerElement# directive as many times as different Polymer elements you are using in your Angular module. [source,typescript] ---- import { Component, NgModule, CUSTOM_ELEMENTS_SCHEMA } from '@angular/core'; import { BrowserModule } from '@angular/platform-browser'; import { PolymerElement } from '@vaadin/angular2-polymer'; @Component({ selector: 'app-root', template: ` ` }) class AppComponent { myValue = 'A'; myItems = ['A', 'B', 'C']; } @NgModule({ imports: [ BrowserModule ], declarations: [ AppComponent, PolymerElement('iron-icon'), PolymerElement('paper-input'), PolymerElement('vaadin-combo-box') ], bootstrap: [ AppComponent ], schemas: [ CUSTOM_ELEMENTS_SCHEMA ] }) export class AppModule { } ---- ================================================ FILE: docs/best-practices.adoc ================================================ --- title: Best practices order: 1 layout: page --- [[angular-polymer.best-practices]] = Angular Polymer best practices This document describes various best practices when using the `angular-polymer` library. == Lists (with `iron-list`) Angular has it's own mechanism for dealing with `