Angularelements html templatefile - New Sample (#745)

* Added a new sample angularelements-html-templatefile.

* Updated README file with detailed implementation.

samples/angularelements-html-templatefile/README.md

@@ -0,0 +1,71 @@
+# Angular Elements with HTML Template File in SharePoint Framework
+
+## Summary
+
+A sample web part illustrating how to use Angular Elements in the SharePoint Framework with the help of separate template HTML File.
+
+## Used SharePoint Framework Version 
+![drop](https://img.shields.io/badge/drop-1.4.1-green.svg)
+
+## Applies to
+
+* [SharePoint Framework](http://dev.office.com/sharepoint/docs/spfx/sharepoint-framework-overview)
+* [Office 365 developer tenant](http://dev.office.com/sharepoint/docs/spfx/set-up-your-developer-tenant)
+
+## Solution
+
+Solution|Author(s)
+--------|---------
+angularelements-html-templatefile| Jayakumar Balasubramaniam (C# Corner MVP, Hubfly, @jayakumrB)
+
+## Version history
+
+Version|Date|Comments
+-------|----|--------
+1.0|Jan 8, 2019|Initial release
+
+## Disclaimer
+**THIS CODE IS PROVIDED *AS IS* WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING ANY IMPLIED WARRANTIES OF FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABILITY, OR NON-INFRINGEMENT.**
+
+---
+
+## Minimal Path to Awesome
+
+* clone this repo
+* in the command line run:
+  * `npm i`
+  * `gulp serve`
+
+## Features
+
+This web part illustrates the following concepts on top of the SharePoint Framework:
+
+* adding Angular Elements to a no-framework SharePoint Framework project
+* bootstrapping Angular Elements inside a SharePoint Framework web part
+* extending the building configuration to build Angular Elements
+* utilizing build pipeline to compile and run angular template files in gulpfile.js
+
+## Implementation
+
+The below piece of code in gulpfile.js is the key to update the build pipeline:
+```
+//************START: Added to handle Template file url ************/
+
+var inlineNgxTemplate = require('gulp-inline-ngx-template');
+var ts = require('gulp-typescript');
+var tsProject = ts.createProject('./tsconfig.json');
+
+let tsInlines = build.subTask('tsInlines', function(gulp, buildOptions, done) {
+  return  gulp.src('src/webparts/helloAngularTemplate/app/**/*.ts')
+       .pipe(inlineNgxTemplate({ base: '/src/webparts/helloAngularTemplate/app/', useRelativePaths: true }))
+       .pipe(tsProject())
+       .pipe(gulp.dest('lib/webparts/helloAngularTemplate/app'));
+})
+
+build.rig.addPostTypescriptTask(tsInlines);
+
+//************END: Added to handle Template file url ************/
+```
+
+
+<img src="https://telemetry.sharepointpnp.com/sp-dev-fx-webparts/samples/angularelements-helloworld" />

samples/angularelements-html-templatefile/config/config.json

@@ -0,0 +1,18 @@
+{
+  "$schema": "https://dev.office.com/json-schemas/spfx-build/config.2.0.schema.json",
+  "version": "2.0",
+  "bundles": {
+    "angular-web-parts": {
+      "components": [
+        {
+          "entrypoint": "./lib/webparts/helloAngularTemplate/HelloAngularWebPart.js",
+          "manifest": "./src/webparts/helloAngularTemplate/HelloAngularWebPart.manifest.json"
+        }        
+      ]
+    }
+  },
+  "externals": {},
+  "localizedResources": {
+    "HelloAngularWebPartStrings": "lib/webparts/helloAngularTemplate/loc/{locale}.js"
+  }
+}

samples/angularelements-html-templatefile/config/copy-assets.json

@@ -0,0 +1,4 @@
+{
+  "$schema": "https://dev.office.com/json-schemas/spfx-build/copy-assets.schema.json",
+  "deployCdnPath": "temp/deploy"
+}

samples/angularelements-html-templatefile/config/deploy-azure-storage.json

@@ -0,0 +1,7 @@
+{
+  "$schema": "https://dev.office.com/json-schemas/spfx-build/deploy-azure-storage.schema.json",
+  "workingDir": "./temp/deploy/",
+  "account": "<!-- STORAGE ACCOUNT NAME -->",
+  "container": "angularelements-helloworld",
+  "accessKey": "<!-- ACCESS KEY -->"
+}

samples/angularelements-html-templatefile/config/package-solution.json

@@ -0,0 +1,13 @@
+{
+  "$schema": "https://dev.office.com/json-schemas/spfx-build/package-solution.schema.json",
+  "solution": {
+    "name": "angularelements-using-templatefile-client-side-solution",
+    "id": "446c046f-46a4-42e5-a5e6-e9e4edfcf09d",
+    "version": "1.0.0.0",
+    "includeClientSideAssets": true,
+    "skipFeatureDeployment": true
+  },
+  "paths": {
+    "zippedPackage": "solution/angularelements-using-templatefile.sppkg"
+  }
+}

samples/angularelements-html-templatefile/config/serve.json

@@ -0,0 +1,10 @@
+{
+  "$schema": "https://dev.office.com/json-schemas/core-build/serve.schema.json",
+  "port": 4321,
+  "https": true,
+  "initialPage": "https://localhost:5432/workbench",
+  "api": {
+    "port": 5432,
+    "entryPath": "node_modules/@microsoft/sp-webpart-workbench/lib/api/"
+  }
+}

samples/angularelements-html-templatefile/config/tslint.json

@@ -0,0 +1,45 @@
+{
+  "$schema": "https://dev.office.com/json-schemas/core-build/tslint.schema.json",
+  // Display errors as warnings
+  "displayAsWarning": true,
+  // The TSLint task may have been configured with several custom lint rules
+  // before this config file is read (for example lint rules from the tslint-microsoft-contrib
+  // project). If true, this flag will deactivate any of these rules.
+  "removeExistingRules": true,
+  // When true, the TSLint task is configured with some default TSLint "rules.":
+  "useDefaultConfigAsBase": false,
+  // Since removeExistingRules=true and useDefaultConfigAsBase=false, there will be no lint rules
+  // which are active, other than the list of rules below.
+  "lintConfig": {
+    // Opt-in to Lint rules which help to eliminate bugs in JavaScript
+    "rules": {
+      "class-name": false,
+      "export-name": false,
+      "forin": false,
+      "label-position": false,
+      "member-access": true,
+      "no-arg": false,
+      "no-console": false,
+      "no-construct": false,
+      "no-duplicate-case": true,
+      "no-duplicate-variable": true,
+      "no-eval": false,
+      "no-function-expression": true,
+      "no-internal-module": true,
+      "no-shadowed-variable": true,
+      "no-switch-case-fall-through": true,
+      "no-unnecessary-semicolons": true,
+      "no-unused-expression": true,
+      "no-use-before-declare": true,
+      "no-with-statement": true,
+      "semicolon": true,
+      "trailing-comma": false,
+      "typedef": false,
+      "typedef-whitespace": false,
+      "use-named-parameter": true,
+      "valid-typeof": true,
+      "variable-name": false,
+      "whitespace": false
+    }
+  }
+}

samples/angularelements-html-templatefile/config/write-manifests.json

@@ -0,0 +1,4 @@
+{
+  "$schema": "https://dev.office.com/json-schemas/spfx-build/write-manifests.schema.json",
+  "cdnBasePath": "<!-- PATH TO CDN -->"
+}

samples/angularelements-html-templatefile/gulpfile.js

@@ -0,0 +1,55 @@
+'use strict';
+
+const gulp = require('gulp');
+const build = require('@microsoft/sp-build-web');
+build.addSuppression(`Warning - [sass] The local CSS class 'ms-Grid' is not camelCase and will not be type-safe.`);
+const webpack = require('webpack');
+const path = require('path');
+const UglifyJSPlugin = require('uglifyjs-webpack-plugin');
+const bundleAnalyzer = require('webpack-bundle-analyzer');
+
+//************START: Added to handle Template file url ************/
+
+var inlineNgxTemplate = require('gulp-inline-ngx-template');
+var ts = require('gulp-typescript');
+var tsProject = ts.createProject('./tsconfig.json');
+
+let tsInlines = build.subTask('tsInlines', function(gulp, buildOptions, done) {
+  return  gulp.src('src/webparts/helloAngularTemplate/app/**/*.ts')
+       .pipe(inlineNgxTemplate({ base: '/src/webparts/helloAngularTemplate/app/', useRelativePaths: true }))
+       .pipe(tsProject())
+       .pipe(gulp.dest('lib/webparts/helloAngularTemplate/app'));
+})
+
+build.rig.addPostTypescriptTask(tsInlines);
+
+//************END: Added to handle Template file url ************/
+
+build.configureWebpack.mergeConfig({
+  additionalConfiguration: (generatedConfiguration) => {
+    const lastDirName = path.basename(__dirname);
+    const dropPath = path.join(__dirname, 'temp', 'stats');
+    generatedConfiguration.plugins.push(new bundleAnalyzer.BundleAnalyzerPlugin({
+      openAnalyzer: false,
+      analyzerMode: 'static',
+      reportFilename: path.join(dropPath, `${lastDirName}.stats.html`),
+      generateStatsFile: true,
+      statsFilename: path.join(dropPath, `${lastDirName}.stats.json`),
+      logLevel: 'error'
+    }));
+
+    generatedConfiguration.plugins.push(new webpack.ContextReplacementPlugin(/\@angular(\\|\/)core(\\|\/)fesm5/, path.join(__dirname, './client')));
+
+    for (let i = 0; i < generatedConfiguration.plugins.length; i++) {
+      const p = generatedConfiguration.plugins[i];
+      if (p.options && p.options.mangle) {
+        generatedConfiguration.plugins.splice(i, 1, new UglifyJSPlugin({ uglifyOptions: { mangle: true } }));
+        break;
+      }
+    }
+
+    return generatedConfiguration;
+  }
+});
+
+build.initialize(gulp);

samples/angularelements-html-templatefile/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "angularelements-helloworld",
+  "version": "0.0.1",
+  "private": true,
+  "engines": {
+    "node": ">=0.10.0"
+  },
+  "scripts": {
+    "build": "gulp bundle",
+    "clean": "gulp clean",
+    "test": "gulp test"
+  },
+  "dependencies": {
+    "@angular/common": "^6.0.3",
+    "@angular/compiler": "^6.0.3",
+    "@angular/core": "^6.0.3",
+    "@angular/elements": "^6.0.3",
+    "@angular/platform-browser": "^6.0.3",
+    "@angular/platform-browser-dynamic": "^6.0.3",
+    "@microsoft/generator-sharepoint": "^1.4.1",
+    "@microsoft/sp-core-library": "~1.4.1",
+    "@microsoft/sp-lodash-subset": "~1.4.1",
+    "@microsoft/sp-office-ui-fabric-core": "~1.4.1",
+    "@microsoft/sp-webpart-base": "~1.4.1",
+    "@pnp/common": "^1.1.0",
+    "@pnp/graph": "^1.1.0",
+    "@pnp/logging": "^1.1.0",
+    "@pnp/odata": "^1.1.0",
+    "@pnp/sp": "^1.1.0",
+    "@types/webpack-env": ">=1.12.1 <1.14.0",
+    "@webcomponents/custom-elements": "^1.1.1",
+    "core-js": "^2.5.7",
+    "rxjs": "^6.2.0",
+    "zone.js": "^0.8.26"
+  },
+  "devDependencies": {
+    "@microsoft/sp-build-web": "~1.4.1",
+    "@microsoft/sp-module-interfaces": "~1.4.1",
+    "@microsoft/sp-webpart-workbench": "~1.4.1",
+    "@types/chai": ">=3.4.34 <3.6.0",
+    "@types/mocha": ">=2.2.33 <2.6.0",
+    "ajv": "~5.2.2",
+    "gulp": "~3.9.1",
+    "gulp-inline-ngx-template": "^4.0.1",
+    "gulp-typescript": "^5.0.0",
+    "uglifyjs-webpack-plugin": "^1.2.5",
+    "webpack-bundle-analyzer": "^2.13.1"
+  }
+}

samples/angularelements-html-templatefile/src/webparts/helloAngularTemplate/HelloAngularWebPart.manifest.json

@@ -0,0 +1,26 @@
+{
+  "$schema": "https://dev.office.com/json-schemas/spfx/client-side-web-part-manifest.schema.json",
+  "id": "8845f211-1e21-42ae-85b1-da871d3e4dc4",
+  "alias": "HelloAngularWebPart",
+  "componentType": "WebPart",
+
+  // The "*" signifies that the version should be taken from the package.json
+  "version": "*",
+  "manifestVersion": 2,
+
+  // If true, the component can only be installed on sites where Custom Script is allowed.
+  // Components that allow authors to embed arbitrary script code should set this to true.
+  // https://support.office.com/en-us/article/Turn-scripting-capabilities-on-or-off-1f2c515f-5d7e-448a-9fd7-835da935584f
+  "requiresCustomScript": false,
+
+  "preconfiguredEntries": [{
+    "groupId": "5c03119e-3074-46fd-976b-c60198311f70", // Other
+    "group": { "default": "Other" },
+    "title": { "default": "Angular HTML Template File" },
+    "description": { "default": "An Angular webpart using template files" },
+    "officeFabricIconFontName": "Page",
+    "properties": {
+      "description": "Hello Angular Template HTML Files"
+    }
+  }]
+}

samples/angularelements-html-templatefile/src/webparts/helloAngularTemplate/HelloAngularWebPart.module.scss

@@ -0,0 +1,74 @@
+@import '~@microsoft/sp-office-ui-fabric-core/dist/sass/SPFabricCore.scss';
+
+.helloAngular {
+  .container {
+    max-width: 700px;
+    margin: 0px auto;
+    box-shadow: 0 2px 4px 0 rgba(0, 0, 0, 0.2), 0 25px 50px 0 rgba(0, 0, 0, 0.1);
+  }
+
+  .row {
+    @include ms-Grid-row;
+    @include ms-fontColor-white;
+    background-color: $ms-color-themeDark;
+    padding: 20px;
+  }
+
+  .column {
+    @include ms-Grid-col;
+    @include ms-lg10;
+    @include ms-xl8;
+    @include ms-xlPush2;
+    @include ms-lgPush1;
+  }
+
+  .title {
+    @include ms-font-xl;
+    @include ms-fontColor-white;
+  }
+
+  .subTitle {
+    @include ms-font-l;
+    @include ms-fontColor-white;
+  }
+
+  .description {
+    @include ms-font-l;
+    @include ms-fontColor-white;
+  }
+
+  .button {
+    // Our button
+    text-decoration: none;
+    height: 32px;
+
+    // Primary Button
+    min-width: 80px;
+    background-color: $ms-color-themePrimary;
+    border-color: $ms-color-themePrimary;
+    color: $ms-color-white;
+
+    // Basic Button
+    outline: transparent;
+    position: relative;
+    font-family: "Segoe UI WestEuropean","Segoe UI",-apple-system,BlinkMacSystemFont,Roboto,"Helvetica Neue",sans-serif;
+    -webkit-font-smoothing: antialiased;
+    font-size: $ms-font-size-m;
+    font-weight: $ms-font-weight-regular;
+    border-width: 0;
+    text-align: center;
+    cursor: pointer;
+    display: inline-block;
+    padding: 0 16px;
+
+    .label {
+      font-weight: $ms-font-weight-semibold;
+      font-size: $ms-font-size-m;
+      height: 32px;
+      line-height: 32px;
+      margin: 0 4px;
+      vertical-align: top;
+      display: inline-block;
+    }
+  }
+}

samples/angularelements-html-templatefile/src/webparts/helloAngularTemplate/HelloAngularWebPart.ts

@@ -0,0 +1,57 @@
+import { Version } from '@microsoft/sp-core-library';
+import {
+  BaseClientSideWebPart,
+  IPropertyPaneConfiguration,
+  PropertyPaneTextField
+} from '@microsoft/sp-webpart-base';
+import { escape } from '@microsoft/sp-lodash-subset';
+
+import styles from './HelloAngularWebPart.module.scss';
+import * as strings from 'HelloAngularWebPartStrings';
+
+import '@webcomponents/custom-elements/src/native-shim';
+import 'core-js/es7/reflect';
+
+import { AppModule } from './app/app.module';
+
+import { enableProdMode } from '@angular/core';
+import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
+
+export interface IHelloAngularWebPartProps {
+  description: string;
+}
+
+export default class HelloAngularWebPart extends BaseClientSideWebPart<IHelloAngularWebPartProps> {
+
+  public render(): void {
+    platformBrowserDynamic().bootstrapModule(AppModule, { ngZone: 'noop' }).then(() => {
+      this.domElement.innerHTML = `<hello-world message="${this.properties.description}"></hello-world>`;
+    });
+  }
+
+  protected get dataVersion(): Version {
+    return Version.parse('1.0');
+  }
+
+  protected getPropertyPaneConfiguration(): IPropertyPaneConfiguration {
+    return {
+      pages: [
+        {
+          header: {
+            description: strings.PropertyPaneDescription
+          },
+          groups: [
+            {
+              groupName: strings.BasicGroupName,
+              groupFields: [
+                PropertyPaneTextField('description', {
+                  label: strings.DescriptionFieldLabel
+                })
+              ]
+            }
+          ]
+        }
+      ]
+    };
+  }
+}

samples/angularelements-html-templatefile/src/webparts/helloAngularTemplate/app/app.module.ts

@@ -0,0 +1,27 @@
+import { BrowserModule } from '@angular/platform-browser';
+import { NgModule, Injector } from '@angular/core';
+import { createCustomElement } from '@angular/elements';
+
+import { HelloWorldComponent } from './helloWorld.component';
+
+@NgModule({
+  imports: [
+    BrowserModule
+  ],
+  declarations: [
+    HelloWorldComponent
+  ],
+  entryComponents: [
+    HelloWorldComponent
+  ]
+})
+export class AppModule {
+  constructor(private injector: Injector) {}
+
+  public ngDoBootstrap() {
+    if(!customElements.get("hello-world")) {
+      const AppElement = createCustomElement(HelloWorldComponent, { injector: this.injector });
+      customElements.define('hello-world', AppElement);
+    }
+   }
+}

samples/angularelements-html-templatefile/src/webparts/helloAngularTemplate/app/helloWorld.component.html

@@ -0,0 +1 @@
+<div>{{ message }}</div>

samples/angularelements-html-templatefile/src/webparts/helloAngularTemplate/app/helloWorld.component.ts

@@ -0,0 +1,12 @@
+import { Component, OnInit, Input } from "@angular/core";
+
+@Component({
+  selector: 'hello-world',
+  templateUrl:"helloWorld.component.html"
+})
+export class HelloWorldComponent implements OnInit {
+  @Input()
+  public message: string;
+
+  public ngOnInit() { }
+}

samples/angularelements-html-templatefile/src/webparts/helloAngularTemplate/loc/en-us.js

@@ -0,0 +1,7 @@
+define([], function() {
+  return {
+    "PropertyPaneDescription": "Description",
+    "BasicGroupName": "Group Name",
+    "DescriptionFieldLabel": "Description Field"
+  }
+});

samples/angularelements-html-templatefile/src/webparts/helloAngularTemplate/loc/mystrings.d.ts

@@ -0,0 +1,10 @@
+declare interface IHelloAngularWebPartStrings {
+  PropertyPaneDescription: string;
+  BasicGroupName: string;
+  DescriptionFieldLabel: string;
+}
+
+declare module 'HelloAngularWebPartStrings' {
+  const strings: IHelloAngularWebPartStrings;
+  export = strings;
+}

samples/angularelements-html-templatefile/tsconfig.json

@@ -0,0 +1,26 @@
+{
+  "compilerOptions": {
+    "target": "es5",
+    "forceConsistentCasingInFileNames": true,
+    "module": "commonjs",
+    "jsx": "react",
+    "declaration": true,
+    "sourceMap": true,
+    "experimentalDecorators": true,
+    "emitDecoratorMetadata": true,
+    "skipLibCheck": true,
+    "typeRoots": [
+      "./node_modules/@types",
+      "./node_modules/@microsoft"
+    ],
+    "types": [
+      "es6-promise",
+      "webpack-env"
+    ],
+    "lib": [
+      "es5",
+      "dom",
+      "es2015.collection"
+    ]
+  }
+}