sp-dev-fx-webparts/samples/angularelements-html-templatefile

page_type	products	languages	extensions
sample	office-sp office-365	javascript typescript	contentType technologies platforms createdDate samples SharePoint Framework AngularJS 1/8/2019 12:00:00 AM

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.

Compatibility

⚠️ Important
Every SPFx version is only compatible with specific version(s) of Node.js. In order to be able to build this sample, please ensure that the version of Node on your workstation matches one of the versions listed in this section. This sample will not work on a different version of Node.
Refer to https://aka.ms/spfx-matrix for more information on SPFx compatibility.

Applies to

• SharePoint Framework
• Office 365 developer tenant

Contributors

• Jayakumar Balasubramaniam

Version history

Version	Date	Comments
1.0	Jan 8, 2019	Initial release

Minimal Path to Awesome

• clone this repo
• in the command line run:
  • npm i
  • gulp serve

This sample can also be opened with VS Code Remote Development. Visit https://aka.ms/spfx-devcontainer for further instructions.

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 ************/

Help

We do not support samples, but we this community is always willing to help, and we want to improve these samples. We use GitHub to track issues, which makes it easy for community members to volunteer their time and help resolve issues.

You can try looking at issues related to this sample to see if anybody else is having the same issues.

You can also try looking at discussions related to this sample and see what the community is saying.

If you encounter any issues while using this sample, create a new issue.

For questions regarding this sample, create a new question.

Finally, if you have an idea for improvement, make a suggestion.

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.