Ngcourse 2
Ngcourse 2
Ngcourse 2
of Contents
Introduction 1.1
License 1.2
Why Angular? 1.3
EcmaScript 6 and TypeScript Features 2.1
ES6 2.1.1
Classes 2.1.1.1
Refresher on 'this' 2.1.1.2
Arrow Functions 2.1.1.3
Template Strings 2.1.1.4
Inheritance 2.1.1.5
Delegation 2.1.1.6
Constants and Block Scoped Variables 2.1.1.7
...spread and ...rest 2.1.1.8
Destructuring 2.1.1.9
Modules 2.1.1.10
TypeScript 2.1.2
Getting Started With TypeScript 2.1.2.1
Working With tsc 2.1.2.2
Typings 2.1.2.3
Linting 2.1.2.4
TypeScript Features 2.1.2.5
TypeScript Classes 2.1.2.6
Interfaces 2.1.2.7
Shapes 2.1.2.8
Type Inference 2.1.2.9
Type Keyword 2.1.2.10
Decorators 2.1.2.11
Property Decorators 2.1.2.12
Class Decorators 2.1.2.13
Parameter Decorators 2.1.2.14
2
The JavaScript Toolchain 3.1
Source Control: git 3.1.1
The Command Line 3.1.2
Command Line JavaScript: NodeJS 3.1.3
Back-End Code Sharing and Distribution: npm 3.1.4
Module Loading, Bundling and Build Tasks: Webpack 3.1.5
Chrome 3.1.6
Bootstrapping an Angular Application 4.1
Understanding the File Structure 4.1.1
Bootstrapping Providers 4.1.2
Components in Angular 5.1
Creating Components 5.1.1
Application Structure with Components 5.1.2
Passing Data into a Component 5.1.2.1
Responding to Component Events 5.1.2.2
Using Two-Way Data Binding 5.1.2.3
Accessing Child Components from Template 5.1.2.4
Projection 5.1.3
Structuring Applications with Components 5.1.4
Using Other Components 5.1.5
Directives 6.1
Attribute Directives 6.1.1
NgStyle Directive 6.1.1.1
NgClass Directive 6.1.1.2
Structural Directives 6.1.2
NgIf Directive 6.1.2.1
NgFor Directive 6.1.2.2
NgSwitch Directives 6.1.2.3
Using Multiple Structural Directives 6.1.2.4
Advanced Components 7.1
Component Lifecycle 7.1.1
Accessing Other Components 7.1.2
View Encapsulation 7.1.3
ElementRef 7.1.4
3
Observables 8.1
Using Observables 8.1.1
Error Handling 8.1.2
Disposing Subscriptions and Releasing Resources 8.1.3
Observables vs Promises 8.1.4
Using Observables From Other Sources 8.1.5
Observables Array Operations 8.1.6
Cold vs Hot Observables 8.1.7
Summary 8.1.8
Angular Dependency Injection 9.1
What is DI? 9.1.1
DI Framework 9.1.2
Angular's DI 9.1.3
@Inject() and @Injectable 9.1.3.1
Injection Beyond Classes 9.1.3.2
Avoiding Injection Collisions: OpaqueToken 9.1.3.3
The Injector Tree 9.1.3.4
Http 10.1
Making Requests 10.1.1
Catching Rejections 10.1.2
Catch and Release 10.1.2.1
Cancel a Request 10.1.2.2
Retry 10.1.2.3
Search with flatMap 10.1.3
Enhancing Search with switchMap 10.1.4
Requests as Promises 10.1.5
Change Detection 11.1
Change Detection Strategies in Angular 1 vs Angular 2 11.1.1
How Change Detection Works 11.1.2
Change Detector Classes 11.1.3
Change Detection Strategy: OnPush 11.1.4
Enforcing Immutability 11.1.5
Additional Resources 11.1.6
4
Zone.js 12.1
Advanced Angular 13.1
Directives 13.1.1
Creating an Attribute Directive 13.1.1.1
Listening to an Element Host 13.1.1.1.1
Setting Properties in a Directive 13.1.1.1.2
Creating a Structural Directive 13.1.1.2
View Containers and Embedded Views 13.1.1.2.1
Providing Context Variables to Directives 13.1.1.2.2
AoT 13.1.2
AoT limitations 13.1.2.1
AoT Configuration 13.1.2.2
Immutable.js 14.1
What is Immutability? 14.1.1
The Case for Immutability 14.1.2
JavaScript Solutions 14.1.3
Object.assign 14.1.3.1
Object.freeze 14.1.3.2
Immutable.js Basics 14.1.4
Immutable.Map 14.1.4.1
Map.merge 14.1.4.1.1
Nested Objects 14.1.4.2
Deleting Keys 14.1.4.2.1
Maps are Iterable 14.1.4.2.2
Immutable.List 14.1.4.3
Performance and Transient Changes 14.1.4.4
Official Documentation 14.1.4.5
Pipes 15.1
Using Pipes 15.1.1
Custom Pipes 15.1.2
Stateful Pipes 15.1.3
Forms 16.1
Getting Started 16.1.1
Template-Driven Forms 16.1.2
5
Nesting Form Data 16.1.2.1
Using Template Model Binding 16.1.2.2
Validating Template-Driven Forms 16.1.2.3
Reactive/Model-Driven Forms 16.1.3
FormBuilder Basics 16.1.3.1
Validating FormBuilder Forms 16.1.3.2
FormBuilder Custom Validation 16.1.3.3
Visual Cues for Users 16.1.4
Modules 17.1
What is an Angular Module? 17.1.1
Adding Components, Pipes and Services to a Module 17.1.2
Creating a Feature Module 17.1.3
Directive Duplications 17.1.4
Lazy Loading a Module 17.1.5
Lazy Loading and the Dependency Injection Tree 17.1.6
Shared Modules and Dependency Injection 17.1.7
Sharing the Same Dependency Injection Tree 17.1.8
Routing 18.1
Why Routing? 18.1.1
Configuring Routes 18.1.2
Redirecting the Router to Another Route 18.1.3
Defining Links Between Routes 18.1.4
Dynamically Adding Route Components 18.1.5
Using Route Parameters 18.1.6
Defining Child Routes 18.1.7
Controlling Access to or from a Route 18.1.8
Passing Optional Parameters to a Route 18.1.9
Using Auxiliary Routes 18.1.10
State Management 19.1
Redux and @ngrx 19.1.1
Adding @ngrx to your Project 19.1.1.1
Defining your Main Application State 19.1.1.2
Example Application 19.1.1.3
6
Reading your Application State using Selectors 19.1.1.4
Actions 19.1.1.5
Modifying your Application State by Dispatching Actions 19.1.1.6
Reducers and Pure Functions 19.1.1.7
Reducers as State Management 19.1.1.8
Creating your Application's Root Reducer 19.1.1.9
Configuring your Application 19.1.1.10
Implementing Components 19.1.1.11
Component Architecture 19.1.1.12
Side Effects 19.1.1.13
Getting More From Redux and @ngrx 19.1.1.14
TDD Testing 20.1
The Testing Toolchain 20.1.1
Test Setup 20.1.2
Filename Conventions 20.1.2.1
Karma Configuration 20.1.2.2
TestBed Configuration (Optional) 20.1.2.3
Typings 20.1.2.4
Executing Test Scripts 20.1.2.5
Simple Test 20.1.3
Using Chai 20.1.4
Testing Components 20.1.5
Verifying Methods and Properties 20.1.5.1
Injecting Dependencies and DOM Changes 20.1.5.2
Overriding Components for Testing 20.1.5.2.1
Testing Asynchronous Actions 20.1.5.3
Refactoring Hard-to-Test Code 20.1.5.4
Testing Services 20.1.6
Testing Strategies for Services 20.1.6.1
Testing HTTP Requests 20.1.6.2
Using MockBackend 20.1.6.2.1
Alternative Mocking Strategy 20.1.6.2.2
Testing JSONP and XHR Back-Ends 20.1.6.2.3
Executing Tests Asynchronously 20.1.6.3
7
Testing Redux 20.1.7
Testing Simple Actions 20.1.7.1
Testing Complex Actions 20.1.7.2
Testing Reducers 20.1.7.3
Afterthoughts 20.1.7.4
Migrating Angular 1.x Projects to Angular 2 21.1
Migration Prep 21.1.1
Upgrading To Angular 1.3+ Style 21.1.1.1
Using Webpack 21.1.1.2
Migrating To TypeScript 21.1.1.3
Choosing an Upgrade Path 21.1.2
Avoiding Total Conversion 21.1.3
Using ng-metadata (Angular 1.x Using 2 Style) 21.1.4
Bootstrapping ng-metadata 21.1.4.1
Components and Services 21.1.4.2
Using ng-upgrade (Angular 1.x Coexisting With Angular 2) 21.1.5
Order of Operations 21.1.5.1
Replacing Services with TypeScript Classes 21.1.5.2
Bootstrapping ng-upgrade 21.1.5.3
Downgrading Components 21.1.5.4
Upgrading Components 21.1.5.5
Projecting Angular 1 Content into Angular 2 Components 21.1.5.6
Transcluding Angular 2 Components into Angular 1 Directives 21.1.5.7
Injecting Across Frameworks 21.1.5.8
Project Setup 22.1
Webpack 22.1.1
Installation and Usage 22.1.1.1
Loaders 22.1.1.2
Plugins 22.1.1.3
Summary 22.1.1.4
NPM Scripts Integration 22.1.2
Angular CLI 23.1
Setup 23.1.1
8
Creating a New App 23.1.2
Serving the App 23.1.3
Creating Components 23.1.4
Creating Routes 23.1.5
Creating Other Things 23.1.6
Testing 23.1.7
Linting 23.1.8
CLI Command Overview 23.1.9
Adding Third Party Libraries 23.1.10
Integrating an Existing App 23.1.11
Accessibility in Angular 24.1
Why Make my Application Accessible? 24.1.1
Key Concerns of Accessible Web Applications 24.1.2
Semantic Markup 24.1.2.1
Keyboard Accessibility 24.1.2.2
Visual Assistance 24.1.2.3
Testing for Accessibility 24.1.3
Is my Application Readable? 24.1.3.1
Is my Application Predictable? 24.1.3.2
Is my Application Navigable? 24.1.3.3
Testing with Screen Readers 24.1.3.4
Additional Resources 24.1.4
Internationalization in Angular 25.1
What is the process like and how is involved? 25.1.1
Marking text in our templates 25.1.2
Extracting translation text using the Angular CLI 25.1.3
How to import the completed translation files 25.1.4
Using the AoT Compiler 25.1.4.1
Using the JiT Compiler 25.1.4.2
Glossary 26.1
Further Reading And Reference 26.2
9
10
Introduction
Over the last three and a half years, Angular has become the leading open source
JavaScript application framework for hundreds of thousands of programmers around the
world. The "1.x" version of Angular has been widely used and became extremely popular for
complex applications. The new Angular 2.x has also announced its final release version.
If you find this material useful, you should also consider registering for one of Rangles
training courses, which facilitate hands-on learning and are a great fit for companies that
need to transition their technology to Angular, or individuals looking to upgrade their skills.
Rangle.io also has an Angular 1.x book which is geared towards writing Angular 1.x
applications in an Angular 2 style. We hope you enjoy this book. We welcome your feedback
in the Discussion Area.
11
Introduction
12
License
License
Creative Commons Attribution-ShareAlike 4.0 International (CC BY-SA 4.0)
Adapt remix, transform and build upon the material for any purpose, even commercially.
The licensor cannot revoke these freedoms as long as you follow the license terms.
ShareAlike If you remix, transform or build upon the material, you must distribute your
contributions under the same license as the original.
No additional restrictions You may not apply legal terms or technological measures that
legally restrict others from doing anything the license permits.
13
Why Angular?
Why Angular?
There are many front-end JavaScript frameworks to choose from today, each with its own
set of trade-offs. Many people were happy with the functionality that Angular 1.x afforded
them. Angular 2 improved on that functionality and made it faster, more scalable and more
modern. Organizations that found value in Angular 1.x will find more value in Angular 2.
Angular's Advantages
The first release of Angular provided programmers with the tools to develop and architect
large scale JavaScript applications, but its age has revealed a number of flaws and sharp
edges. Angular 2 was built on five years of community feedback.
Angular 2 Is Easier
The new Angular codebase is more modern, more capable and easier for new programmers
to learn than Angular 1.x, while also being easier for project veterans to work with.
TypeScript
Angular 2 was written in TypeScript, a superset of JavaScript that implements many new
ES2016+ features.
By focusing on making the framework easier for computers to process, Angular 2 allows for
a much richer development ecosystem. Programmers using sophisticated text editors (or
IDEs) will notice dramatic improvements with auto-completion and type suggestions. These
14
Why Angular?
improvements help to reduce the cognitive burden of learning Angular 2. Fortunately for
traditional ES5 JavaScript programmers this does not mean that development must be done
in TypeScript or ES2015: programmers can still write vanilla JavaScript that runs without
transpilation.
Familiarity
Despite being a complete rewrite, Angular 2 has retained many of its core concepts and
conventions with Angular 1.x, e.g. a streamlined, "native JS" implementation of dependency
injection. This means that programmers who are already proficient with Angular will have an
easier time migrating to Angular 2 than another library like React or framework like Ember.
Angular 2, like React and other modern frameworks, can leverage performance gains by
rendering HTML on the server or even in a web worker. Depending on application/site
design this isomorphic rendering can make a user's experience feel even more
instantaneous.
The quest for performance does not end with pre-rendering. Angular 2 makes itself portable
to native mobile by integrating with NativeScript, an open source library that bridges
JavaScript and mobile. Additionally, the Ionic team is working on an Angular 2 version of
their product, providing another way to leverage native device features with Angular.
Angular 1.x tried to work around various browser limitations related to JavaScript. This was
done by introducing a module system that made use of dependency injection. This system
was novel, but unfortunately had issues with tooling, notably minification and static analysis.
15
Why Angular?
Angular 2.x makes use of the ES2015 module system, and modern packaging tools like
webpack or SystemJS. Modules are far less coupled to the "Angular way", and it's easier to
write more generic JavaScript and plug it into Angular. The removal of minification
workarounds and the addition of rigid prescriptions make maintaining existing applications
simpler. The new module system also makes it easier to develop effective tooling that can
reason better about larger projects.
New Features
Some of the other interesting features in Angular 2 are:
Form Builder
Change Detection
Templating
Routing
Annotations
Observables
Shadow DOM
Angular 1.x
Old School Transitional
Best Angular 2
Angular 1.x Architecture
Practices
Nested scopes
Used
("$scope", Avoided Avoided Gone
heavily
watches)
16
Why Angular?
17
EcmaScript 6 and TypeScript Features
The language we usually call "JavaScript" is formally known as "EcmaScript". The new
version of JavaScript, known as "ES6", offers a number of new features that extend the
power of the language.
ES6 is not widely supported in today's browsers, so it needs to be transpiled to ES5. You
can choose between several transpilers, but we'll be using TypeScript, which is what the
Angular team uses to write Angular. Angular makes use of a number of features of ES6 and
TypeScript.
18
ES6
ES6
JavaScript was created in 1995, but the language is still thriving today. There are subsets,
supersets, current versions and the latest version ES6 that brings a lot of new features.
Classes
Arrow Functions
Template Strings
Inheritance
Constants and Block Scoped Variables
Spread and Rest operators
Destructuring
Modules
19
Classes
Classes
Classes are a new feature in ES6, used to describe the blueprint of an object and make
EcmaScript's prototypical inheritance model function more like a traditional class-based
language.
class Hamburger {
constructor() {
// This is the constructor.
}
listToppings() {
// This is a method.
}
}
Traditional class-based languages often reserve the word this to reference the current
(runtime) instance of the class. In Javascript this refers to the calling context and therefore
can change to be something other than the object.
Object
An object is an instance of a class which is created using the new operator. When using a
dot notation to access a method on the object, this will refer to the object to the left of the
dot.
In the snippet above, whenever this is used from inside class Hamburger, it will refer to
object burger .
20
Classes
21
Refresher on 'this'
A Refresher on this
Inside a JavaScript class we'll be using this keyword to refer to the instance of the class.
E.g., consider this case:
class Toppings {
...
list() {
return this.formatToppings(this.toppings);
}
}
Here this refers to an instance of the Toppings class. As long as the list method is
called using dot notation, like myToppings.list() , then this.formatToppings(this.toppings)
invokes the formatToppings() method defined on the instance of the class. This will also
ensure that inside formatToppings , this refers to the same instance.
However, this can also refer to other things. There are two basic cases that you should
remember.
1. Method invocation:
someObject.someMethod();
Here, this used inside someMethod will refer to someObject , which is usually what
you want.
2. Function invocation:
someFunction();
Here, this used inside someFunction can refer to different things depending on
whether we are in "strict" mode or not. Without using the "strict" mode, this refers to
the context in which someFunction() was called. This is rarely what you want, and it
can be confusing when this is not what you were expecting, because of where the
function was called from. In "strict" mode, this would be undefined, which is slightly
less confusing.
22
Refresher on 'this'
View Example
One of the implications is that you cannot easily detach a method from its object. Consider
this example:
In many browsers this will give you an error. That's because log expects this to refer to
console , but the reference was lost when the function was detached from console .
This can be fixed by setting this explicitly. One way to do this is by using bind() method,
which allows you to specify the value to use for this inside the bound function.
You can also achieve the same using Function.call and Function.apply , but we won't
discuss this here.
Another instance where this can be confusing is with respect to anonymous functions, or
functions declared within other functions. Consider the following:
class ServerRequest {
notify() {
...
}
fetch() {
getFromServer(function callback(err, data) {
this.notify(); // this is not going to work
});
}
}
In the above case this will not point to the expected object: in "strict" mode it will be
undefined . This leads to another ES6 feature - arrow functions, which will be covered next.
23
Arrow Functions
Arrow Functions
ES6 offers some new syntax for dealing with this : "arrow functions".
Arrow functions also make higher order functions much easier to work with.
The new "fat arrow" notation can be used to define anonymous functions in a simpler way.
items.forEach(function(x) {
console.log(x);
incrementedItems.push(x+1);
});
items.forEach((x) => {
console.log(x);
incrementedItems.push(x+1);
});
Functions that calculate a single expression and return its values can be defined even
simpler:
There is one important difference, however: arrow functions do not set a local copy of this ,
arguments , super , or new.target . When this is used inside an arrow function
JavaScript uses the this from the outer scope. Consider the following example:
24
Arrow Functions
class Toppings {
constructor(toppings) {
this.toppings = Array.isArray(toppings) ? toppings : [];
}
outputList() {
this.toppings.forEach(function(topping, i) {
console.log(topping, i + '/' + this.toppings.length); // `this` will be undefin
ed
});
}
}
myToppings.outputList();
Let's try this code on http://jsbin.com. As we see, this gives us an error, since this is
undefined inside the anonymous function.
class Toppings {
constructor(toppings) {
this.toppings = Array.isArray(toppings) ? toppings : [];
}
outputList() {
this.toppings.forEach((topping, i) => {
console.log(topping, i + '/' + this.toppings.length) // `this` works!
});
}
}
myToppings.outputList();
Let's try this code on http://jsbin.com. Here this inside the arrow function refers to the
instance variable.
Warning arrow functions do not have their own arguments variable, which can be confusing
to veteran JavaScript programmers. super and new.target are also scoped from the outer
enclosure.
25
Template Strings
Template Strings
In traditional JavaScript, text that is enclosed within matching " or ' marks is considered
a string. Text within double or single quotes can only be on one line. There was no way to
insert data into these strings. This resulted in a lot of ugly concatenation code that looked
like:
console.log('hello my name is ' + name + ' I am ' + age + ' years old');
ES6 introduces a new type of string literal that is marked with back ticks (`). These string
literals can include newlines, and there is a string interpolation for inserting variables into
strings:
There are all sorts of places where this kind of string can come in handy, and front-end web
development is one of them.
26
Inheritance
Inheritance
JavaScript's inheritance works differently from inheritance in other languages, which can be
very confusing. ES6 classes provide a syntactic sugar attempting to alleviate the issues with
using prototypical inheritance present in ES5.
To illustrate this, let's image we have a zoo application where types of birds are created. In
classical inheritance, we define a base class and then subclass it to create a derived class.
Subclassing
The example code below shows how to derive Penguin from Bird using the extends
keyword. Also pay attention to the super keyword used in the subclass constructor of
Penguin , it is used to pass the argument to the base class Bird 's constructor.
The Bird class defines the method walk which is inherited by the Penguin class and is
available for use by instance of Penguin objects. Likewise the Penguin class defines the
method swim which is not avilable to Bird objects. Inheritance works top-down from base
class to its subclass.
Object Initialization
The class constructor is called when an object is created using the new operator, it will be
called before the object is fully created. A consturctor is used to pass in arguments to
initialize the newly created object.
The order of object creation starts from its base class and then moves down to any
subclass(es).
27
Inheritance
walk() {
console.log('walk!');
}
}
// Subclass
class Penguin extends Bird {
constructor(weight, height) {
super(weight, height);
}
swim() {
console.log('swim!');
}
}
// Penguin object
let penguin = new Penguin(...);
penguin.walk(); //walk!
penguin.swim(); //swim!
Below we show how prototypal inheritance was done before class was introduced to
JavaScript.
28
Inheritance
// Bird constructor
function Bird(weight, height) {
this.weight = weight;
this.height = height;
}
// Penguin constructor.
function Penguin(weight, height) {
Bird.call(this, weight, height);
}
29
Delegation
Delegation
In the inheritance section we looked at one way to extend a class functionality, there is
second way using delegation to extend functionality. With delegation, one object will contain
a reference to a different object that it will hand off a request to perform the functionality.
The code below shows how to use delegation with the Bird class and Penguin class. The
Penguin class has a reference to the Bird class and it delegates the call made to it's walk
// ES6
class Bird {
constructor(weight, height) {
this.weight = weight;
this.height = height;
}
walk() {
console.log('walk!');
}
}
class Penguin {
constructor(bird) {
this.bird = bird;
}
walk() {
this.bird.walk();
}
swim() {
console.log('swim!');
}
}
30
Constants and Block Scoped Variables
var five = 5;
var threeAlso = three; // error
function scope1() {
var three = 3;
var fiveAlso = five; // == 5
var sevenAlso = seven; // error
}
function scope2() {
var seven = 7;
var fiveAlso = five; // == 5
var threeAlso = three; // error
}
In ES5 functions were essentially containers that could be "seen" out of, but not into.
In ES6 var still works that way, using functions as containers, but there are two new ways
to declare variables: const and let .
const and let use { and } blocks as containers, hence "block scope". Block scoping
var i;
for (i = 0; i < 10; i += 1) {
var j = i;
let k = i;
}
console.log(j); // 9
console.log(k); // undefined
Despite the introduction of block scoping, functions are still the preferred mechanism for
dealing with most loops.
let works like var in the sense that its data is read/write. let is also useful when used
in a for loop. For example, without let, the following example would output 5,5,5,5,5 :
31
Constants and Block Scoped Variables
However, when using let instead of var , the value would be scoped in a way that people
would expect.
Alternatively, const is read-only. Once const has been assigned, the identifier cannot be
reassigned.
For example:
However there are two cases where const does not work as you think it should.
32
Constants and Block Scoped Variables
The example above demonstrates that we are able to change the name property of object
person, but we are unable to reset the reference person since it has been marked as
const .
let person = {
name: 'Tammy'
};
const p = person;
Take away, marking an object reference const does not make properties inside the object
const.
Ref:.
33
...spread and ...rest
1. Array
2. Function call
3. Multiple variable destructuring
Rest parameters works in the opposite direction of the spread syntax, it collects an indefinite
number of comma separated expressions into an array.
Spread Syntax
Spread example:
Functions aren't the only place in JavaScript that makes use of comma separated lists -
arrays can now be concatenated with ease:
Rest parameter
Rest parameters share the ellipsis like syntax of spread syntax but are used for a different
purpose. Rest parameters are used to access indefinite number of arguments passed to a
function. For example:
34
...spread and ...rest
function addSimple(a, b) {
return a + b;
}
function add(...numbers) {
return numbers[0] + numbers[1];
}
addSimple(3, 2); // 5
add(3, 2); // 5
// or in es6 style:
const addEs6 = (...numbers) => numbers.reduce((p, c) => p + c, 0);
addEs6(1, 2, 3); // 6
Technically JavaScript already had an arguments variable set on each function (except for
arrow functions), however arguments has a lot of issues, one of which is the fact that it is
not technically an array.
Rest parameters are in fact arrays which provides access to methods like map, filter,
reduce and more . The other important difference is that rest parameters only include
print(1, 2, 3, 4, 5);
// 4
// 1
Note: Commonly spread syntax and rest parameters are referenced as Spread and Rest
operators but they aren't operators according to ECMAScript specifications. Few references
MDN-Spread Syntax, MDN-Rest Parameters, ECMAScript Spec - Spread Syntax,
ECMAScript Spec - Rest Parameters
35
Destructuring
Destructuring
Destructuring is a way to quickly extract data out of an {} or [] without having to write
much code.
To borrow from the MDN, destructuring can be used to turn the following:
into
This is pretty interesting, but at first it might be hard to see the use case. ES6 also supports
object destructuring, which might make uses more obvious:
let myModule = {
drawSquare: function drawSquare(length) { /* implementation */ },
drawCircle: function drawCircle(radius) { /* implementation */ },
drawText: function drawText(text) { /* implementation */ },
};
drawSquare(5);
drawText('hello');
Destructuring can also be used for passing objects into a function, allowing you to pull
specific properties out of an object in a concise manner. It is also possible to assign default
values to destructured arguments, which can be a useful pattern if passing in a configuration
object.
36
Destructuring
There are many more sophisticated things that can be done with destructuring, and the MDN
has some great examples, including nested object destructuring and dynamic destructuring
with for ... in operators".
37
Modules
ES6 Modules
ES6 introduced module support. A module in ES6 is single file that allows code and data to
be isolated, it helps in organizing and grouping code logically. In other languages it's called a
package or library.
All code and data inside the module has file scope, what this means is they are not
accessible from code outside the module. To share code or data outside a module, it needs
to be exported using the export keyword.
// File: circle.js
The code above uses the Arrow function for circumference . Read more about arrow
functions here
Module Systems
Using a module on the backend(server side) is relatively straightforward, you simply make
use of the import keyword. However Web Browsers have no concept of modules or import,
they just know how to load javascript code. We need a way to bring in a javascript module to
start using it from other javascript code. This is where a module loader comes in.
We won't get into the various module systems out there, but it's worth understanding there
are various module loaders available. The popular choices out there are:
RequireJS
SystemJS
Webpack
38
Modules
Loading ES6 modules is a little trickier. In an ES6-compliant browser you use the System
keyword to load modules asynchronously. To make our code work with current browsers,
however, we will use the SystemJS library as a polyfill:
<script src="/node_module/systemjs/dist/system.js"></script>
<script>
var promise = System.import('app')
.then(function() {
console.log('Loaded!');
})
.then(null, function(error) {
console.error('Failed to load:', error);
});
</script>
39
TypeScript
TypeScript
ES6 is the current version of JavaScript. TypeScript is a superset of ES6, which means all
ES6 features are part of TypeScript, but not all TypeScript features are part of ES6.
Consequently, TypeScript must be transpiled into ES5 to run in most browsers.
One of TypeScript's primary features is the addition of type information, hence the name.
This type information can help make JavaScript programs more predictable and easier to
reason about.
Types let developers write more explicit "contracts". In other words, things like function
signatures are more explicit.
Without TS:
function add(a, b) {
return a + b;
}
add(1, 3); // 4
add(1, '3'); // '13'
With TS:
add(1, 3); // 4
// compiler error before JS is even produced
add(1, '3'); // '13'
40
Getting Started With TypeScript
Then use tsc to manually compile a TypeScript source file into ES5:
$ tsc test.ts
$ node test.js
class Pizza {
toppings: string[];
constructor(toppings: string[]) {
this.toppings = toppings;
}
}
Note that now that we've declared toppings to be an array of strings, TypeScript will
enforce this. If we try to assign a number to it, we will get an error at compilation time.
If you want to have a property that can be set to a value of any type, however, you can still
do this: just declare its type to be "any":
class Pizza {
toppings: any;
//...
}
41
Working With tsc
a.ts
b.ts
Before [email protected]:
Hmmm. What's the deal with this module flag? TypeScript has a help menu, let's take a look:
(TypeScript has more help than what we've shown; we filtered by grep for brevity.) There
are two help entries that reference "module", and --module is the one TypeScript was
complaining about. The description explains that TypeScript supports a number of different
module schemes. For the moment commonjs is desirable. This will produce modules that
are compatible with node.js's module system.
Since [email protected], tsc has a default rule for --module option: target === 'ES6' ?
'ES6' : 'commonjs' (more details can be found here), so we can simply run:
42
Working With tsc
tsc should produce no output. In many command line traditions, no output is actually a
mark of success. Listing the directory contents will confirm that our TypeScript files did in
fact compile.
$ ls
a.js a.ts b.js b.ts
Excellent - there are now two JavaScript modules ready for consumption.
Telling the tsc command what to compile becomes tedious and labor intensive even on
small projects. Fortunately TypeScript has a means of simplifying this. tsconfig.json files
let programmers write down all the compiler settings they want. When tsc is run, it looks
for tsconfig.json files and uses their rules to compile JavaScript.
For Angular projects there are a number of specific settings that need to be configured in a
project's tsconfig.json
{
"compilerOptions": {
"module": "commonjs",
"target": "es5",
"emitDecoratorMetadata": true,
"experimentalDecorators": true,
"noImplicitAny": false,
"removeComments": false,
"sourceMap": true
},
"exclude": [
"node_modules",
"dist/"
]
}
Target
The compilation target. TypeScript supports targeting different platforms depending on your
needs. In our case, we're targeting modern browsers which support ES5.
Module
43
Working With tsc
The target module resolution interface. We're integrating TypeScript through webpack which
supports different interfaces. We've decided to use node's module resolution interface,
commonjs .
Decorators
Decorator support in TypeScript hasn't been finalized yet but since Angular uses decorators
extensively, these need to be set to true. Decorators have not been introduced yet, and will
be covered later in this section.
// webpack.config.js
//...
rules: [
{ test: /\.ts$/, loader: 'ts', exclude: /node_modules/ },
//...
]
This loader calls tsc for us, and it will use our tsconfig.json .
44
Typings
Typings
Astute readers might be wondering what happens when TypeScript programmers need to
interface with JavaScript modules that have no type information. TypeScript recognizes files
labelled *.d.ts as definition files. These files are meant to use TypeScript to describe
interfaces presented by JavaScript libraries.
There are communities of people dedicated to creating typings for JavaScript projects. There
is also a utility called typings ( npm install --save-dev typings ) that can be used to
manage third party typings from a variety of sources. (Deprecated in TypeScript 2.0)
In TypeScript 2.0, users can get type files directly from @types through npm (for example,
npm install --save @types/lodash will install lodash type file).
45
Linting
Linting
Many editors support the concept of "linting" - a grammar check for computer programs.
Linting can be done in a programmer's editor and/or through automation.
For TypeScript there is a package called tslint , ( npm install --save-dev tslint ) which
can be plugged into many editors. tslint can also be configured with a tslint.json file.
Webpack can run tslint before it attempts to run tsc . This is done by installing tslint-
loader ( npm install --save-dev tslint-loader ) which plugs into webpack like so:
// ...
module: {
preLoaders: [
{ test: /\.ts$/, loader: 'tslint' }
],
loaders: [
{ test: /\.ts$/, loader: 'ts', exclude: /node_modules/ },
// ...
]
// ...
}
46
TypeScript Features
TypeScript Features
Now that producing JavaScript from TypeScript code has been de-mystified, some of its
features can be described and experimented with.
Types
Interfaces
Shapes
Decorators
Types
Many people do not realize it, but JavaScript does in fact have types, they're just "duck
typed", which roughly means that the programmer does not have to think about them.
JavaScript's types also exist in TypeScript:
boolean (true/false)
{} Object literal
void nothing
47
TypeScript Features
This illustrates the primitive types in TypeScript, and ends by illustrating a showMessage
function. In this function the parameters have specific types that are checked when tsc is
run.
In many JavaScript functions it's quite common for functions to take optional parameters.
TypeScript provides support for this, like so:
Using a ? lets tsc know that isDebug is an optional parameter. tsc will not complain if
isDebug is omitted.
48
TypeScript Classes
TypeScript Classes
TypeScript also treats class es as their own type:
class Baz {
constructor(foo: Foo, bar: Bar) { }
}
Like function parameters, class es sometimes have optional members. The same ?:
syntax can be used on a class definition:
class Person {
name: string;
nickName?: string;
}
In the above example, an instance of Person is guaranteed to have a name , and might
optionally have a nickName
49
Interfaces
Interfaces
An interface is a TypeScript artifact, it is not part of ECMAScript. An interface is a way to
define a contract on a function with respect to the arguments and their type. Along with
functions, an interface can also be used with a Class as well to define custom types.
An interface is an abstract type, it does not contain any code as a class does. It only defines
the 'signature' or shape of an API. During transpilation, an interface will not generate any
code, it is only used by Typescript for type checking during development.
interface Callback {
(error: Error, data: any): void;
}
Sometimes JavaScript functions can accept multiple types as well as varying arguments,
that is, they can have different call signatures. Interfaces can be used to specify this.
interface PrintOutput {
(message: string): void; // common case
(message: string[]): void; // less common case
}
printOut('hello'); // 'hello'
printOut(['hi', 'bye']); // 'hi, bye'
50
Interfaces
interface Action {
type: string;
}
let a: Action = {
type: 'literal'
}
51
Shapes
Shapes
Underneath TypeScript is JavaScript, and underneath JavaScript is typically a JIT (Just-In-
Time compiler). Given JavaScript's underlying semantics, types are typically reasoned about
by "shapes". These underlying shapes work like TypeScript's interfaces, and are in fact how
TypeScript compares custom types like class es and interface s.
interface Action {
type: string;
}
let a: Action = {
type: 'literal'
}
class NotAnAction {
type: string;
constructor() {
this.type = 'Constructor function (class)';
}
}
Despite the fact that Action and NotAnAction have different identifiers, tsc lets us assign
an instance of NotAnAction to a which has a type of Action . This is because TypeScript
only really cares that objects have the same shape. In other words if two objects have the
same attributes, with the same typings, those two objects are considered to be of the same
type.
52
Type Inference
Type Inference
One common misconception about TypeScript's types is that code needs to explicitly
describe types at every possible opportunity. Fortunately this is not the case. TypeScript has
a rich type inference system that will "fill in the blanks" for the programmer. Consider the
following:
type-inference-finds-error.ts
tsc ./type-inference-finds-error.ts
type-inference-finds-error.ts(2,1): error TS2322: Type 'string[]' is not assignable to
type 'number[]'.
Type 'string' is not assignable to type 'number'.
The code contains no extra type information. In fact, it's valid ES6.
If var had been used, it would be valid ES5. Yet TypeScript is still able to determine type
information.
Type inference can also work through context, which is handy with callbacks. Consider the
following:
type-inference-finds-error-2.ts
interface FakeEvent {
type: string;
}
interface FakeEventHandler {
(e: FakeEvent): void;
}
class FakeWindow {
onMouseDown: FakeEventHandler
}
const fakeWindow = new FakeWindow();
53
Type Inference
tsc ./type-inference-finds-error-2.ts
type-inference-finds-error-2.ts(14,1): error TS2322: Type '(a: number) => void' is not
assignable to type 'FakeEventHandler'.
Types of parameters 'a' and 'e' are incompatible.
Type 'number' is not assignable to type 'FakeEvent'.
Property 'type' is missing in type 'Number'.
In this example the context is not obvious since the interfaces have been defined explicitly.
In a browser environment with a real window object, this would be a handy feature,
especially the type completion of the Event object.
54
Type Keyword
Type Keyword
The type keyword defines an alias to a type.
At first glance, this does not appear to be very useful (even the error mentions the original
type), but as type annotations become more complex, the benefits of the type keyword
become apparent.
Union Types
Union types allow type annotations to specify that a property should be one of a set of types
(either/or).
A union type of string literal types is a very useful pattern, creating what is basically an enum
with string values.
55
Type Keyword
goToParty("pizza hut");
goToParty("chuck e. cheese"); // Argument of type `"chuck e. cheese"' is not assignabl
e to parameter of type 'PartyZone'
Intersection Types
Intersection types are the combination of two or more types. Useful for objects and params
that need to implement more than one interface.
interface Kicker {
kick(speed: number): number;
}
interface Puncher {
punch(power: number): number;
}
// assign intersection type definition to alias KickPuncher
type KickPuncher = Kicker & Puncher;
The syntax is similar to ES6 fat-arrow functions. ([params]) => [return type] .
56
Type Keyword
To illustrate the how much the type keyword improved the readability of the previous
snippet, here is the function type defined inline.
function sendRequest (cb: (err: Error|null, response: Object) => void): void {
if (cb) {
cb(null, {});
}
}
57
Decorators
Decorators
Decorators are proposed for a future version of JavaScript, but the Angular team really
wanted to use them, and they have been included in TypeScript.
Decorators are functions that are invoked with a prefixed @ symbol, and immediately
followed by a class , parameter, method or property. The decorator function is supplied
information about the class , parameter or method, and the decorator function returns
something in its place, or manipulates its target in some way. Typically the "something" a
decorator returns is the same thing that was passed in, but it has been augmented in some
way.
Decorators are quite new in TypeScript, and most use cases demonstrate the use of existing
decorators. However, decorators are just functions, and are easier to reason about after
walking through a few examples.
Decorators are functions, and there are four things ( class , parameter, method and
property) that can be decorated; consequently there are four different function signatures for
decorators:
Readers who have played with Angular will notice that these signatures do not look like the
signatures used by Angular specific decorators like @Component() .
Notice the () on @Component . This means that the @Component is called once JavaScript
encounters @Component() . In turn, this means that there must be a Component function
somewhere that returns a function matching one of the decorator signatures outlined above.
This is an example of the decorator factory pattern.
If decorators still look confusing, perhaps some examples will clear things up.
58
Property Decorators
Property Decorators
Property decorators work with properties of classes.
class Test {
@Override('test') // invokes Override, which returns the decorator
name: string = 'pat';
}
The above example must be compiled with both the --experimentalDecorators and --
emitDecoratorMetadata flags.
In this case the decorated property is replaced by the label passed to the decorator. It's
important to note that property values cannot be directly manipulated by the decorator;
instead an accessor is used.
class Test {
@ReadOnly // notice there are no `()`
name: string;
}
In this case the name property is not writable , and remains undefined.
59
Property Decorators
60
Class Decorators
Class Decorators
function log(prefix?: string) {
return (target) => {
// save a reference to the original constructor
var original = target;
@log('hello')
class World {
}
In the example log is invoked using @ , and passed a string as a parameter, @log()
returns an anonymous function that is the actual decorator.
The decorator function takes a class , or constructor function (ES5) as an argument. The
decorator function then returns a new class construction function that is used whenever
World is instantiated.
This decorator does nothing other than log out its given parameter, and its target 's class
name to the console.
61
Class Decorators
62
Parameter Decorators
Parameter Decorators
function logPosition(target: any, propertyKey: string, parameterIndex: number) {
console.log(parameterIndex);
}
class Cow {
say(b: string, @logPosition c: boolean) {
console.log(b);
}
}
The above demonstrates decorating method parameters. Readers familiar with Angular can
now imagine how Angular implemented their @Inject() system.
63
The JavaScript Toolchain
64
Source Control: git
For more information on how to use Git, head over to Pro Git
65
The Command Line
We will provide examples for all command line activities required by this course.
66
Command Line JavaScript: NodeJS
While Node.js was initially intended for writing server code in JavaScript, today it is widely
used by JavaScript tools, which makes it relevant to front-end programmers too. A lot of the
tools you'll be using in this course leverage Node.js.
67
Back-End Code Sharing and Distribution: npm
It also performs dependency management for your back-end application. You specify
module dependencies in a file called package.json ; running npm install will resolve,
download and install your back-end application's dependencies.
68
Module Loading, Bundling and Build Tasks: Webpack
69
Chrome
Web Browsers
We use Google's Chrome browser for this course because of its cutting-edge JavaScript
engine and excellent debugging tools.
However you are free to use other browsers. Not well known, there is a Mozilla Firefox
Developer Edition available with support for great development and debugging tools. Code
written with JavaScript should work on any modern web browser (Firefox, IE9+, Chrome,
Safari, Opera).
70
Bootstrapping an Angular Application
Bootstrapping Angular applications is certainly different from Angular 1.x, but is still a
straightforward procedure. Let's take a look at how this is done.
71
Understanding the File Structure
app/app.component.ts
@Component({
selector: 'app-root',
template: '<b>Bootstrapping an Angular Application</b>'
})
export class AppComponent { }
index.html
<body>
<app-root>Loading...</app-root>
</body>
app/app.module.ts
@NgModule({
imports: [BrowserModule],
declarations: [AppComponent],
bootstrap: [AppComponent]
})
export class AppModule {
}
app/main.ts
72
Understanding the File Structure
platformBrowserDynamic().bootstrapModule(AppModule);
If you're making use of Ahead-of-Time (AoT) compilation, you would code main.ts as
follows.
platformBrowser().bootstrapModuleFactory(AppModuleNgFactory);
View Example
The bootstrap process loads main.ts which is the main entry point of the application. The
AppModule operates as the root module of our application. The module is configured to use
AppComponent as the component to bootstrap, and will be rendered on any app-root HTML
element encountered.
There is an app HTML element in the index.html file, and we use app/main.ts to import the
AppModule component and the platformBrowserDynamic().bootstrapModule function and
kickstart the process. As shown above, you may optionally use AoT in which case you will
be working with Factories, in the example, AppModuleNgFactory and
bootstrapModuleFactory .
Why does Angular bootstrap itself in this way? Well there is actually a very good reason.
Since Angular is not a web-only based framework, we can write components that will run in
NativeScript, or Cordova, or any other environment that can host Angular applications.
The magic is then in our bootstrapping process - we can import which platform we would like
to use, depending on the environment we're operating under. In our example, since we were
running our Angular application in the browser, we used the bootstrapping process found in
@angular/platform-browser-dynamic .
It's also a good idea to leave the bootstrapping process in its own separate main.ts file. This
makes it easier to test (since the components are isolated from the bootstrap call), easier
to reuse and gives better organization and structure to our application.
There is more to understanding Angular Modules and @NgModule which will be covered
later, but for now this is enough to get started.
73
Understanding the File Structure
74
Bootstrapping Providers
Bootstrapping Providers
The bootstrap process also starts the dependency injection system in Angular. We won't go
over Angular's dependency injection system here - that is covered later. Instead let's take a
look at an example of how to bootstrap your application with application-wide providers.
For this, we will register a service called GreeterService with the providers property of the
module we are using to bootstrap the application.
app/app.module.ts
@NgModule({
imports: [BrowserModule],
providers: [GreeterService],
declarations: [AppComponent],
bootstrap: [AppComponent]
})
export class AppModule { }
View Example
75
Components in Angular
Components in Angular
Figure: components
The core concept of any Angular application is the component. In effect, the whole
application can be modeled as a tree of these components.
A component controls a patch of screen real estate that we could call a view, and
declares reusable UI building blocks for an application.
Basically, a component is anything that is visible to the end user and which can be reused
many times within an application.
In Angular 1.x we had router views and directives which worked sort of like components. The
idea of directive components became quite popular. They were created by using directive
with a controller while relying on the controllerAs and bindToController properties. For
example:
76
Components in Angular
angular.module('ngcourse')
.directive('ngcHelloComponent', () => ({
restrict: 'E',
scope: { name: '=' },
template: '<span>Hello, {{ ctrl.name }}.</span>',
controller: MyComponentCtrl,
controllerAs: 'ctrl',
bindToController: true
})
);
In fact, this concept became so popular that in Angular 1.5 the .component method was
introduced as syntactic sugar.
angular.module('ngcourse')
.component('ngcHelloComponent', {
bindings: { name: '=' },
template: '<span>Hello, {{ $ctrl.name }}.</span>',
controller: MyComponentCtrl
});
77
Creating Components
Creating Components
Components in Angular 2 build upon the lessons learned from Angular 1.5. We define a
component's application logic inside a class. To this we attach @Component , a TypeScript
decorator , which allows you to modify a class or function definition and adds metadata to
selector is the element property that we use to tell Angular to create and insert an
instance of this component.
template is a form of HTML that tells Angular what needs to be to rendered in the DOM.
The Component below will interpolate the value of name variable into the template between
the double braces {{name}} , what get rendered in the view is <p>Hello World</p> .
@Component({
selector: 'rio-hello',
template: '<p>Hello, {{name}}!</p>',
})
export class HelloComponent {
name: string;
constructor() {
this.name = 'World';
}
}
We need to import the Component decarator from @angular/core before we can make use
of it. To use this component we simply add <rio-hello></rio-hello> to the HTML file or
another template, and Angular will insert an instance of the HelloComponent view between
those tags.
View Example
78
Application Structure with Components
<rio-todo-app>
<rio-todo-list>
<rio-todo-item></rio-todo-item>
<rio-todo-item></rio-todo-item>
<rio-todo-item></rio-todo-item>
</rio-todo-list>
<rio-todo-form></rio-todo-form>
</rio-todo-app>
79
Passing Data into a Component
The @Input() decorator defines a set of parameters that can be passed down from the
component's parent. For example, we can modify the HelloComponent component so that
name can be provided by the parent.
@Component({
selector: 'rio-hello',
template: '<p>Hello, {{name}}!</p>',
})
export class HelloComponent {
@Input() name: string;
}
The point of making components is not only encapsulation, but also reusability. Inputs allow
us to configure a particular instance of a component.
View Example
80
Responding to Component Events
@Component({
selector: 'rio-counter',
template: `
<div>
<p>Count: {{num}}</p>
<button (click)="increment()">Increment</button>
</div>
`
})
export class CounterComponent {
num = 0;
increment() {
this.num++;
}
}
View Example
To send data out of components via outputs, start by defining the outputs attribute. It accepts
a list of output parameters that a component exposes to its parent.
app/counter.component.ts
@Component({
selector: 'rio-counter',
templateUrl: 'app/counter.component.html'
})
export class CounterComponent {
@Input() count = 0;
@Output() result = new EventEmitter<number>();
increment() {
this.count++;
this.result.emit(this.count);
}
}
81
Responding to Component Events
app/counter.component.html
<div>
<p>Count: {{ count }}</p>
<button (click)="increment()">Increment</button>
</div>
app/app.component.ts
@Component({
selector: 'rio-app',
templateUrl: 'app/app.component.html'
})
export class AppComponent implements OnChange {
num = 0;
parentCount = 0;
ngOnChange(val: number) {
this.parentCount = val;
}
}
app/app.component.html
<div>
Parent Num: {{ num }}<br>
Parent Count: {{ parentCount }}
<rio-counter [count]="num" (result)="ngOnChange($event)">
</rio-counter>
</div>
View Example
Together a set of input + output bindings define the public API of your component. In our
templates we use the [squareBrackets] to pass inputs and the (parenthesis) to handle
outputs.
82
Using Two-Way Data Binding
To create your own component that supports two-way binding, you must define an @Output
property to match an @Input , but suffix it with the Change . The code example below, inside
class CounterComponent shows how to make property count support two-way binding.
app/counter.component.ts
@Component({
selector: 'rio-counter',
templateUrl: 'app/counter.component.html'
})
export class CounterComponent {
@Input() count = 0;
@Output() countChange = EventEmitter<number>();
increment() {
this.count++;
this.countChange.emit(this.count);
}
}
app/counter.component.html
<div>
<p>
<ng-content></ng-content>
Count: {{ count }} -
<button (click)="increment()">Increment</button>
</p>
</div>
83
Using Two-Way Data Binding
View Example
84
Accessing Child Components from Template
The most straightforward examples of this may be seen dealing with forms or inputs:
app/app.component.html
<section >
<form #myForm="ngForm" (ngSubmit)="onSubmit(myForm)">
<label for="name">Name</label>
<input type="text" name="name" id="name" ngModel>
<button type="submit">Submit</button>
</form>
Form Value: {{formValue}}
</section>
app/app.component.ts
@Component({
selector: 'rio-app',
templateUrl: 'app/app.component.html'
})
export class AppComponent {
formValue = JSON.stringify({});
View Example
This isn't a magic feature which only forms or inputs have, but rather a way of referencing
the instance of a child component in your template. With that reference, you can then access
public properties and methods on that component.
app/app.component.html
85
Accessing Child Components from Template
<rio-profile #profile></rio-profile>
My name is {{ profile.name }}
app/profile.component.ts
@Component({
selector: 'rio-profile',
templateUrl: 'app/profile.component.html'
})
export class ProfileComponent {
name = 'John Doe';
}
View Example
There are other means of accessing and interfacing with child components, but if you simply
need to reference properties or methods of a child, this can be a simple and straightforward
method of doing so.
86
Projection
Projection
Projection is a very important concept in Angular. It enables developers to build reusable
components and make applications more scalable and flexible. To illustrate that, suppose we
have a ChildComponent like:
@Component({
selector: 'rio-child',
template: `
<div>
<h4>Child Component</h4>
{{ childContent }}
</div>
`
})
export class ChildComponent {
childContent = "Default content";
}
you wanted to provide styled HTML, or other components? Trying to handle this with an
@Input can get messy quickly, and this is where content projection comes in. Components
by default support projection, and you can use the ngContent directive to place the
projected content in your template.
@Component({
selector: 'rio-child',
template: `
<div style="border: 1px solid blue; padding: 1rem;">
<h4>Child Component</h4>
<ng-content></ng-content>
</div>
`
})
export class ChildComponent {
}
87
Projection
app/app.component.html
...
<rio-child>
<p>My <i>projected</i> content.</p>
</rio-child>
...
This is telling Angular, that for any markup that appears between the opening and closing
tag of <rio-child> , to place inside of <ng-content></ng-content> .
When doing this, we can have other components, markup, etc projected here and the
ChildComponent does not need to know about or care what is being provided.
View Example
But what if we have multiple <ng-content></ng-content> and want to specify the position of
the projected content to certain ng-content ? For example, for the previous
ChildComponent , if we want to format the projected content into an extra header and
footer section:
app/child-select.component.html
<div style="...">
<h4>Child Component with Select</h4>
<div style="...">
<ng-content select="header"></ng-content>
</div>
<div style="...">
<ng-content select="section"></ng-content>
</div>
<div style="...">
<ng-content select=".class-select"></ng-content>
</div>
<div style="...">
<ng-content select="footer"></ng-content>
</div>
</div>
Then in the template, we can use directives, say, <header> to specify the position of
projected content to the ng-content with select="header" :
app/app.component.html
88
Projection
...
<rio-child-select>
<section>Section Content</section>
<div class="class-select">
div with .class-select
</div>
<footer>Footer Content</footer>
<header>Header Content</header>
</rio-child-select>
...
Besides using directives, developers can also select a ng-content through css class:
<ng-content select=".class-select"></ng-content>
app/app.component.html
<div class="class-select">
div with .class-select
</div>
View Example
89
Structuring Applications with Components
90
Using Other Components
@NgModule({
imports: [ ... ],
declarations: [
TodoListComponent,
TodoItemComponent,
TodoInputComponent
],
bootstrap: [ ... ]
})
export class ToDoAppModule {
}
The property declarations expects an array of components, directives and pipes that are
part of the module.
Please see the Modules section for more info about NgModule .
91
Directives
Directives
A Directive modifies the DOM to change apperance, behavior or layout of DOM elements.
Directives are one of the core building blocks Angular uses to build applications. In fact,
Angular components are in large part directives with templates.
From an Angular 1.x perspective, Angular 2 components have assumed a lot of the roles
directives used to. The majority of issues that involve templates and dependency injection
rules will be done through components, and issues that involve modifying generic behaviour
is done through directives.
92
Attribute Directives
Attribute Directives
Attribute directives are a way of changing the appearance or behavior of a component or a
native DOM element. Ideally, a directive should work in a way that is component agnostic
and not bound to implementation details.
For example, Angular has built-in attribute directives such as ngClass and ngStyle that
work on any component or element.
93
NgStyle Directive
NgStyle Directive
Angular provides a built-in directive, ngStyle , to modify a component or element's style
attribute. Here's an example:
@Component({
selector: 'app-style-example',
template: `
<p style="padding: 1rem"
[ngStyle]="{
'color': 'red',
'font-weight': 'bold',
'borderBottom': borderStyle
}">
<ng-content></ng-content>
</p>
`
})
export class StyleExampleComponent {
borderStyle = '1px solid black';
}
View Example
Notice that binding a directive works the exact same way as component attribute bindings.
Here, we're binding an expression, an object literal, to the ngStyle directive so the directive
name must be enclosed in square brackets. ngStyle accepts an object whose properties
and values define that element's style. In this case, we can see that both kebab case and
lower camel case can be used when specifying a style property. Also notice that both the
html style attribute and Angular ngStyle directive are combined when styling the
element.
We can remove the style properties out of the template into the component as a property
object, which then gets assigned to NgStyle using property binding. This allows dynamic
changes to the values as well as provides the flexibility to add and remove style properties.
94
NgStyle Directive
@Component({
selector: 'app-style-example',
template: `
<p style="padding: 1rem"
[ngStyle]="alertStyles">
<ng-content></ng-content>
</p>
`
})
export class StyleExampleComponent {
borderStyle = '1px solid black';
alertStyles = {
'color': 'red',
'font-weight': 'bold',
'borderBottom': this.borderStyle
};
}
95
NgClass Directive
NgClass Directive
The ngClass directive changes the class attribute that is bound to the component or
element it's attached to. There are a few different ways of using the directive.
Binding a string
We can bind a string directly to the attribute. This works just like adding an html class
attribute.
@Component({
selector: 'app-class-as-string',
template: `
<p ngClass="centered-text underlined" class="orange">
<ng-content></ng-content>
</p>
`,
styles: [`
.centered-text {
text-align: center;
}
.underlined {
border-bottom: 1px solid #ccc;
}
.orange {
color: orange;
}
`]
})
export class ClassAsStringComponent {
}
View Example
In this case, we're binding a string directly so we avoid wrapping the directive in square
brackets. Also notice that the ngClass works with the class attribute to combine the final
classes.
Binding an array
96
NgClass Directive
@Component({
selector: 'app-class-as-array',
template: `
<p [ngClass]="['warning', 'big']">
<ng-content></ng-content>
</p>
`,
styles: [`
.warning {
color: red;
font-weight: bold;
}
.big {
font-size: 1.2rem;
}
`]
})
export class ClassAsArrayComponent {
}
View Example
Here, since we are binding to the ngClass directive by using an expression, we need to
wrap the directive name in square brackets. Passing in an array is useful when you want to
have a function put together the list of applicable class names.
Binding an object
Lastly, an object can be bound to the directive. Angular applies each property name of that
object to the component if that property is true.
97
NgClass Directive
@Component({
selector: 'app-class-as-object',
template: `
<p [ngClass]="{ card: true, dark: false, flat: flat }">
<ng-content></ng-content>
<br>
<button type="button" (click)="flat=!flat">Toggle Flat</button>
</p>
`,
styles: [`
.card {
border: 1px solid #eee;
padding: 1rem;
margin: 0.4rem;
font-family: sans-serif;
box-shadow: 2px 2px 2px #888888;
}
.dark {
background-color: #444;
border-color: #000;
color: #fff;
}
.flat {
box-shadow: none;
}
`]
})
export class ClassAsObjectComponent {
flat: boolean = true;
}
View Example
Here we can see that since the object's card and flat properties are true, those classes
are applied but since dark is false, it's not applied.
98
Structural Directives
Structural Directives
Structural Directives are a way of handling how a component or element renders through the
use of the template tag. This allows us to run some code that decides what the final
rendered output will be. Angular has a few built-in structural directives such as ngIf ,
ngFor , and ngSwitch .
Note: For those who are unfamiliar with the template tag, it is an HTML element with a few
special properties. Content nested in a template tag is not rendered on page load and is
something that is meant to be loaded through code at runtime. For more information on the
template tag, visit the MDN documentation.
Structural directives have their own special syntax in the template that works as syntactic
sugar.
@Component({
selector: 'app-directive-example',
template: `
<p *structuralDirective="expression">
Under a structural directive.
</p>
`
})
Instead of being enclosed by square brackets, our dummy structural directive is prefixed with
an asterisk. Notice that the binding is still an expression binding even though there are no
square brackets. That's due to the fact that it's syntactic sugar that allows using the directive
in a more intuitive way and similar to how directives were used in Angular 1. The component
template above is equivalent to the following:
@Component({
selector: 'app-directive-example',
template: `
<template [structuralDirective]="expression">
<p>
Under a structural directive.
</p>
</template>
`
})
Here, we see what was mentioned earlier when we said that structural directives use the
template tag. Angular also has a built-in template directive that does the same thing:
99
Structural Directives
@Component({
selector: 'app-directive-example',
template: `
<p template="structuralDirective expression">
Under a structural directive.
</p>
`
})
100
NgIf Directive
NgIf Directive
The ngIf directive conditionally adds or removes content from the DOM based on whether
or not an expression is true or false.
Here's our app component, where we bind the ngIf directive to an example component.
@Component({
selector: 'app-root',
template: `
<button type="button" (click)="toggleExists()">Toggle Component</button>
<hr>
<app-if-example *ngIf="exists">
Hello
</app-if-example>
`
})
export class AppComponent {
exists = true;
toggleExists() {
this.exists = !this.exists;
}
}
View Example
Clicking the button will toggle whether or not IfExampleComponent is a part of the DOM and
not just whether it is visible or not. This means that every time the button is clicked,
IfExampleComponent will be created or destroyed. This can be an issue with components that
have expensive create/destroy actions. For example, a component could have a large child
subtree or make several HTTP calls when constructed. In these cases it may be better to
avoid using ngIf if possible.
101
NgFor Directive
NgFor Directive
The NgFor directive is a way of repeating a template by using each item of an iterable as
that template's context.
@Component({
selector: 'app-root',
template: `
<app-for-example *ngFor="let episode of episodes" [episode]="episode">
{{episode.title}}
</app-for-example>
`
})
export class AppComponent {
episodes = [
{ title: 'Winter Is Coming', director: 'Tim Van Patten' },
{ title: 'The Kingsroad', director: 'Tim Van Patten' },
{ title: 'Lord Snow', director: 'Brian Kirk' },
{ title: 'Cripples, Bastards, and Broken Things', director: 'Brian Kirk' },
{ title: 'The Wolf and the Lion', director: 'Brian Kirk' },
{ title: 'A Golden Crown', director: 'Daniel Minahan' },
{ title: 'You Win or You Die', director: 'Daniel Minahan' },
{ title: 'The Pointy End', director: 'Daniel Minahan' }
];
}
View Example
The NgFor directive has a different syntax from other directives we've seen. If you're
familiar with the for...of statement, you'll notice that they're almost identical. NgFor lets you
specify an iterable object to iterate over and the name to refer to each item by inside the
scope. In our example, you can see that episode is available for interpolation as well as
property binding. The directive does some extra parsing so that when this is expanded to
template form, it looks a bit different:
@Component({
selector: 'app',
template: `
<template ngFor [ngForOf]="episodes" let-episode>
<app-for-example [episode]="episode">
{{episode.title}}
</app-for-example>
</template>
`
})
102
NgFor Directive
View Example
Notice that there is an odd let-episode property on the template element. The NgFor
directive provides some variables as context within its scope. let-episode is a context
binding and here it takes on the value of each item of the iterable.
Local Variables
NgFor also provides other values that can be aliased to local variables:
@Component({
selector: 'app-root',
template: `
<app-for-example
*ngFor="let episode of episodes; let i = index; let isOdd = odd"
[episode]="episode"
[ngClass]="{ odd: isOdd }">
{{i+1}}. {{episode.title}}
</app-for-example>
<hr>
<h2>Desugared</h2>
View Example
trackBy
103
NgFor Directive
Often NgFor is used to iterate through a list of objects with a unique ID field. In this case,
we can provide a trackBy function which helps Angular keep track of items in the list so
that it can detect which items have been added or removed and improve performance.
Angular will try and track objects by reference to determine which items should be created
and destroyed. However, if you replace the list with a new source of objects, perhaps as a
result of an API request - we can get some extra performance by telling Angular how we
want to keep track of things.
For example, if the Add Episode button was to make a request and return a new list of
episodes, we might not want to destroy and re-create every item in the list. If the episodes
have a unique ID, we could add a trackBy function:
104
NgFor Directive
@Component({
selector: 'app-root',
template: `
<button
(click)="addOtherEpisode()"
[disabled]="otherEpisodes.length === 0">
Add Episode
</button>
<app-for-example
*ngFor="let episode of episodes;
let i = index; let isOdd = odd;
trackBy: trackById" [episode]="episode"
[ngClass]="{ odd: isOdd }">
{{episode.title}}
</app-for-example>
`
})
export class AppComponent {
otherEpisodes = [
{ title: 'Two Swords', director: 'D. B. Weiss', id: 8 },
{ title: 'The Lion and the Rose', director: 'Alex Graves', id: 9 },
{ title: 'Breaker of Chains', director: 'Michelle MacLaren', id: 10 },
{ title: 'Oathkeeper', director: 'Michelle MacLaren', id: 11 }]
episodes = [
{ title: 'Winter Is Coming', director: 'Tim Van Patten', id: 0 },
{ title: 'The Kingsroad', director: 'Tim Van Patten', id: 1 },
{ title: 'Lord Snow', director: 'Brian Kirk', id: 2 },
{ title: 'Cripples, Bastards, and Broken Things', director: 'Brian Kirk', id: 3 },
{ title: 'The Wolf and the Lion', director: 'Brian Kirk', id: 4 },
{ title: 'A Golden Crown', director: 'Daniel Minahan', id: 5 },
{ title: 'You Win or You Die', director: 'Daniel Minahan', id: 6 }
{ title: 'The Pointy End', director: 'Daniel Minahan', id: 7 }
];
addOtherEpisode() {
// We want to create a new object reference for sake of example
let episodesCopy = JSON.parse(JSON.stringify(this.episodes))
this.episodes=[...episodesCopy,this.otherEpisodes.pop()];
}
trackById(index: number, episode: any): number {
return episode.id;
}
}
To see how this can affect the ForExample component, let's add some logging to it.
105
NgFor Directive
ngOnInit() {
console.log('component created', this.episode)
}
ngOnDestroy() {
console.log('destroying component', this.episode)
}
}
View Example
When we view the example, as we click on Add Episode , we can see console output
indicating that only one component was created - for the newly added item to the list.
However, if we were to remove the trackBy from the *ngFor - every time we click the
button, we would see the items in the component getting destroyed and recreated.
106
NgSwitch Directives
NgSwitch Directives
ngSwitch is actually comprised of two directives, an attribute directive and a structural
directive. It's very similar to a switch statement in JavaScript and other programming
languages, but in the template.
@Component({
selector: 'app-root',
template: `
<div class="tabs-selection">
<app-tab [active]="isSelected(1)" (click)="setTab(1)">Tab 1</app-tab>
<app-tab [active]="isSelected(2)" (click)="setTab(2)">Tab 2</app-tab>
<app-tab [active]="isSelected(3)" (click)="setTab(3)">Tab 3</app-tab>
</div>
<div [ngSwitch]="tab">
<app-tab-content *ngSwitchCase="1">Tab content 1</app-tab-content>
<app-tab-content *ngSwitchCase="2">Tab content 2</app-tab-content>
<app-tab-content *ngSwitchCase="3"><app-tab-3></app-tab-3></app-tab-content>
<app-tab-content *ngSwitchDefault>Select a tab</app-tab-content>
</div>
`
})
export class AppComponent {
tab: number = 0;
setTab(num: number) {
this.tab = num;
}
isSelected(num: number) {
return this.tab === num;
}
}
View Example
Here we see the ngSwitch attribute directive being attached to an element. This expression
bound to the directive defines what will compared against in the switch structural directives.
If an expression bound to ngSwitchCase matches the one given to ngSwitch , those
components are created and the others destroyed. If none of the cases match, then
components that have ngSwitchDefault bound to them will be created and the others
destroyed. Note that multiple components can be matched using ngSwitchCase and in those
cases all matching components will be created. Since components are created or destroyed
be aware of the costs in doing so.
107
NgSwitch Directives
108
Using Multiple Structural Directives
@Component({
selector: 'app-root',
template: `
<template ngFor [ngForOf]="[1,2,3,4,5,6]" let-item>
<div *ngIf="item > 3">
{{item}}
</div>
</template>
`
})
View Example
The previous tabs example can use ngFor and ngSwitch if the tab title and content is
abstracted away into the component class.
109
Using Multiple Structural Directives
@Component({
selector: 'app-root',
template: `
<div class="tabs-selection">
<tab
*ngFor="let tab of tabs; let i = index"
[active]="isSelected(i)"
(click)="setTab(i)">
{{ tab.title }}
</tab>
</div>
<div [ngSwitch]="tabNumber">
<template ngFor [ngForOf]="tabs" let-tab let-i="index">
<tab-content *ngSwitchCase="i">
{{tab.content}}
</tab-content>
</template>
<tab-content *ngSwitchDefault>Select a tab</tab-content>
</div>
`
})
export class AppComponent {
tabNumber: number = -1;
tabs = [
{ title: 'Tab 1', content: 'Tab content 1' },
{ title: 'Tab 2', content: 'Tab content 2' },
{ title: 'Tab 3', content: 'Tab content 3' },
];
setTab(num: number) {
this.tabNumber = num;
}
isSelected(num: number) {
return this.tabNumber === i;
}
}
View Example
110
Advanced Components
Advanced Components
Now that we are familiar with component basics, we can look at some of the more
interesting things we can do with them.
111
Component Lifecycle
Component Lifecycle
A component has a lifecycle managed by Angular itself. Angular manages creation,
rendering, data-bound properties etc. It also offers hooks that allow us to respond to key
lifecycle events.
View Example
112
Accessing Other Components
The @ViewChild is a decorator function that takes the name of a component class as its
input and finds its selector in the template of the containing component to bind to.
@ViewChild can also be passed a template reference variable.
For example, we bind the class AlertComponent to its selector <app-alert> and assign it to
the property alert . This allows us to gain access to class methods, like show() .
@Component({
selector: 'app-root',
template: `
<app-alert>My alert</app-alert>
<button (click)="showAlert()">Show Alert</button>`
})
export class AppComponent {
@ViewChild(AlertComponent) alert: AlertComponent;
showAlert() {
this.alert.show();
}
}
View Example
In the interest of separation of concerns, we'd normally want to have child elements take
care of their own behaviors and pass in an @Input() . However, it might be a useful
construct in keeping things generic.
When there are multiple embedded components in the template, we can also use
@ViewChildren . It collects a list of instances of the Alert component, stored in a QueryList
113
Accessing Other Components
@Component({
selector: 'app-root',
template: `
<app-alert ok="Next" (close)="showAlert(2)">
Step 1: Learn angular
</app-alert>
<app-alert ok="Next" (close)="showAlert(3)">
Step 2: Love angular
</app-alert>
<app-alert ok="Close">
Step 3: Build app
</app-alert>
<button (click)="showAlert(1)">Show steps</button>`
})
export class AppComponent {
@ViewChildren(AlertComponent) alerts: QueryList<AlertComponent>;
alertsArr = [];
ngAfterViewInit() {
this.alertsArr = this.alerts.toArray();
}
showAlert(step) {
this.alertsArr[step - 1].show(); // step 1 is alert index 0
}
}
View Example
As shown above, given a class type to @ViewChild and @ViewChildren a child component
or a list of children component are selected respectively using their selector from the
template. In addition both @ViewChild and @ViewChildren can be passed a selector string:
114
Accessing Other Components
@Component({
selector: 'app-root',
template: `
<app-alert #first ok="Next" (close)="showAlert(2)">
Step 1: Learn angular
</app-alert>
<app-alert ok="Next" (close)="showAlert(3)">
Step 2: Love angular
</app-alert>
<app-alert ok="Close">
Step 3: Build app
</app-alert>
<button (click)="showAlert(1)">Show steps</button>`
})
export class AppComponent {
@ViewChild('first') alert: AlertComponent;
@ViewChildren(AlertComponent) alerts: QueryList<AlertComponent>;
// ...
}
View Example
Note that view children will not be set until the ngAfterViewInit lifecycle hook is called.
Again, note that content children will not be set until the ngAfterContentInit component
lifecycle hook.
View Example
115
View Encapsulation
View Encapsulation
View encapsulation defines whether the template and styles defined within the component
can affect the whole application or vice versa. Angular provides three encapsulation
strategies:
Emulated (default) - styles from main HTML propagate to the component. Styles
defined in this component's @Component decorator are scoped to this component only.
Native - styles from main HTML do not propagate to the component. Styles defined in
visible to all components on the page. Be careful with apps that have None and
Native components in the application. All components with None encapsulation will
@Component({
// ...
encapsulation: ViewEncapsulation.None,
styles: [
// ...
]
})
export class HelloComponent {
// ...
}
View Example
116
ElementRef
ElementRef
Provides access to the underlying native element (DOM element).
@Component({
selector: 'app-root',
template: `
<h1>My App</h1>
<pre>
<code>{{ node }}</code>
</pre>
`
})
export class AppComponent implements AfterContentInit {
node: string;
ngAfterContentInit() {
const tmp = document.createElement('div');
const el = this.elementRef.nativeElement.cloneNode(true);
tmp.appendChild(el);
this.node = tmp.innerHTML;
}
View Example
117
Observables
Observables
An exciting new feature used with Angular is the Observable . This isn't an Angular specific
feature, but rather a proposed standard for managing async data that will be included in the
release of ES7. Observables open up a continuous channel of communication in which
multiple values of data can be emitted over time. From this we get a pattern of dealing with
data by using array-like operations to parse, modify and maintain data. Angular uses
observables extensively - you'll see them in the HTTP service and the event system.
118
Using Observables
Using Observables
Let's take a look at a basic example of how to create and use an Observable in an Angular
component:
@Component({
selector: 'app',
template: `
<b>Angular Component Using Observables!</b>
constructor() {
}
init() {
this.data = new Observable(observer => {
setTimeout(() => {
observer.next(42);
}, 1000);
setTimeout(() => {
observer.next(43);
}, 2000);
setTimeout(() => {
observer.complete();
}, 3000);
});
119
Using Observables
View Example
First we import Observable into our component from rxjs/Observable . Next, in our
constructor we create a new Observable . Note that this creates an Observable data type
that contains data of number type. This illustrates the stream of data that Observables offer
as well as giving us the ability to maintain integrity of the type of data we are expecting to
receive.
Next we call subscribe on this Observable which allows us to listen in on any data that is
coming through. In subscribing we use three distinctive callbacks: the first one is invoked
when receiving new values, the second for any errors that arise and the last represents the
function to be invoked when the sequence of incoming data is complete and successful.
We can also use forEach to listen for incoming data. The key difference between forEach
and subscribe is in how the error and completion callbacks are handled. The forEach call
only accepts the 'next value' callback as an argument; it then returns a promise instead of a
subscription.
When the Observable completes, the promise resolves. When the Observable encounters
an error, the promise is rejected.
The forEach pattern is useful for a sequence of events you only expect to happen once.
120
Using Observables
constructor() {
}
init() {
this.data = new Observable(observer => {
setTimeout(() => {
observer.next(42);
}, 1000);
setTimeout(() => {
observer.next(43);
}, 2000);
setTimeout(() => {
observer.complete();
}, 3000);
this.status = "Started";
});
View Example
121
Error Handling
Error Handling
If something unexpected arises we can raise an error on the Observable stream and use
the function reserved for handling errors in our subscribe routine to see what happened.
constructor() {
View Example
Here an error is raised and caught. One thing to note is that if we included a .complete()
after we raised the error, this event will not actually fire. Therefore you should remember to
include some call in your error handler that will turn off any visual loading states in your
application.
122
Disposing Subscriptions and Releasing Resources
init() {
this.status = 'Started';
setTimeout(() => {
subscription.unsubscribe();
}, 1000);
}
View Example
123
Disposing Subscriptions and Releasing Resources
unsubscribed. This is useful for any kind of cleanup that must be implemented. If we did not
clear the setTimeout then values would still be emitting, but there would be no one listening.
To save resources we should stop values from being emitted. An important thing to note is
that when you call .unsubscribe() you are destroying the subscription object that is
listening, therefore the on-complete event attached to that subscription object will not get
called.
In most cases we will not need to explicitly call the unsubscribe method unless we want to
cancel early or our Observable has a longer lifespan than our subscription. The default
behavior of Observable operators is to dispose of the subscription as soon as .complete()
or .error() messages are published. Keep in mind that RxJS was designed to be used in
a "fire and forget" fashion most of the time.
124
Observables vs Promises
Observables vs Promises
Both Promises and Observables provide us with abstractions that help us deal with the
asynchronous nature of our applications. However, there are important differences between
the two:
As seen in the example above, Observables can define both the setup and teardown
aspects of asynchronous behavior.
Moreover, Observables can be retried using one of the retry operators provided by the
API, such as retry and retryWhen . On the other hand, Promises require the caller to
have access to the original function that returned the promise in order to have a retry
capability.
125
Using Observables From Other Sources
However, we will often create Observables from callbacks, promises, events, collections or
using many of the operators available on the API.
@Component({
selector: 'app',
template: `
<b>Angular HTTP requests using RxJs Observables!</b>
<ul>
<li *ngFor="let doctor of doctors">{{doctor.name}}</li>
</ul>
`
})
constructor(http: Http) {
http.get('http://jsonplaceholder.typicode.com/users/')
.flatMap((data) => data.json())
.subscribe((data) => {
this.doctors.push(data);
});
}
}
View Example
126
Using Observables From Other Sources
This basic example outlines how the Http library's common routines like get , post ,
put and delete all return Observables that allow us to asynchronously process any
resulting data.
@Component({
selector: 'app',
template: `
<form [formGroup]="coolForm">
<input formControlName="email">
</form>
<div>
<b>You Typed Reversed:</b> {{data}}
</div>
`
})
email: FormControl;
coolForm: FormGroup;
data: string;
this.coolForm = fb.group({
email: this.email
});
this.email.valueChanges
.map(n=>n.split('').reverse().join(''))
.subscribe(value => this.data = value);
}
}
View Example
127
Using Observables From Other Sources
Here we have created a new form by initializing a new FormControl field and grouped it into
a FormGroup tied to the coolForm HTML form. The Control field has a property
.valueChanges that returns an Observable that we can subscribe to. Now whenever a user
128
Observables Array Operations
Let's expand our example and do something a little more with our stream:
constructor(http: Http) {
http.get('http://jsonplaceholder.typicode.com/users/')
.flatMap((response) => response.json())
.filter((person) => person.id > 5)
.map((person) => "Dr. " + person.name)
.subscribe((data) => {
this.doctors.push(data);
});
}
}
View Example
Here are two really useful array operations - map and filter . What exactly do these do?
map will create a new array with the results of calling a provided function on every
element in this array. In this example we used it to create a new result set by iterating
through each item and appending the "Dr." abbreviation in front of every user's name.
Now every object in our array has "Dr." prepended to the value of its name property.
filter will create a new array with all elements that pass the test implemented by a
provided function. Here we have used it to create a new result set by excluding any user
whose id property is less than six.
Now when our subscribe callback gets invoked, the data it receives will be a list of JSON
objects whose id properties are greater than or equal to six and whose name properties
have been prepended with Dr. .
Note the chaining function style, and the optional static typing that comes with TypeScript,
that we used in this example. Most importantly functions like filter return an Observable ,
as in Observables beget other Observables , similarly to promises. In order to use map and
filter in a chaining sequence we have flattened the results of our Observable using
129
Observables Array Operations
flatMap . Since filter accepts an Observable , and not an array, we have to convert our
array of JSON objects from data.json() to an Observable stream. This is done with
flatMap .
There are many other array operations you can employ in your Observables ; look for them
in the RxJS API.
130
Cold vs Hot Observables
setTimeout(() => {
observer.next(1);
}, 1000);
setTimeout(() => {
observer.next(2);
}, 2000);
setTimeout(() => {
observer.next(3);
}, 3000);
setTimeout(() => {
observer.next(4);
}, 4000);
});
// Subscription A
setTimeout(() => {
obsv.subscribe(value => console.log(value));
}, 0);
// Subscription B
setTimeout(() => {
obsv.subscribe(value => console.log(`>>>> ${value}`));
}, 2500);
View Example
In the above case subscriber B subscribes 2000ms after subscriber A. Yet subscriber B is
starting to get values like subscriber A only time shifted. This behavior is referred to as a
cold Observable . A useful analogy is watching a pre-recorded video, such as on Netflix. You
press Play and the movie starts playing from the beginning. Someone else can start playing
the same movie in their own home 25 minutes later.
On the other hand there is also a hot Observable , which is more like a live performance.
You attend a live band performance from the beginning, but someone else might be 25
minutes late to the show. The band will not start playing from the beginning and the
131
Cold vs Hot Observables
We have already encountered both kind of Observables . The example above is a cold
Observable , while the example that uses valueChanges on our text field input is a hot
Observable .
we will have to explicitly call connect on our hot Observable to start broadcasting values to
its subscribers.
setTimeout(() => {
observer.next(1);
}, 1000);
setTimeout(() => {
observer.next(2);
}, 2000);
setTimeout(() => {
observer.next(3);
}, 3000);
setTimeout(() => {
observer.next(4);
}, 4000);
}).publish();
obsv.connect();
// Subscription A
setTimeout(() => {
obsv.subscribe(value => console.log(value));
}, 0);
// Subscription B
setTimeout(() => {
obsv.subscribe(value => console.log(` ${value}`));
}, 2500);
View Example
132
Cold vs Hot Observables
In the case above, the live performance starts at 1000ms , subscriber A arrived to the concert
hall at 0s to get a good seat and our subscriber B arrived at the performance at 2500ms
and missed a bunch of songs.
Another useful method to work with hot Observables instead of connect is refCount . This
is an auto connect method, that will start broadcasting as soon as there is more than one
subscriber. Analogously, it will stop if the number of subscribers goes to 0; in other words, if
everyone in the audience walks out, the performance will stop.
133
Summary
Summary
Observables offer a flexible set of APIs for composing and transforming asynchronous
streams. They provide a multitude of functions to create streams from many other types, and
to manipulate and transform them. We've taken a look at how Angular uses Observables to
create streams from many other types to read user input, perform asynchronous data
fetches and set up custom emit/subscribe routines.
rxjs 4 to 5 migration
rxjs Observable API
Which operator do I use?
rxmarbles
RxJS Operators by Example
134
Angular Dependency Injection
Angular 2 improves on Angular 1.x's DI model by unifying Angular 1.x's two injection
systems. Tooling issues with respect to static analysis, minification and namespace
collisions have also been fixed in Angular 2.
135
What is DI?
What is DI?
So dependency injection makes programmers' lives easier, but what does it really do?
class Hamburger {
private bun: Bun;
private patty: Patty;
private toppings: Toppings;
constructor() {
this.bun = new Bun('withSesameSeeds');
this.patty = new Patty('beef');
this.toppings = new Toppings(['lettuce', 'pickle', 'tomato']);
}
}
The above code is a contrived class that represents a hamburger. The class assumes a
Hamburger consists of a Bun , Patty and Toppings . The class is also responsible for
making the Bun , Patty and Toppings . This is a bad thing. What if a vegetarian burger
were needed? One naive approach might be:
class VeggieHamburger {
private bun: Bun;
private patty: Patty;
private toppings: Toppings;
constructor() {
this.bun = new Bun('withSesameSeeds');
this.patty = new Patty('tofu');
this.toppings = new Toppings(['lettuce', 'pickle', 'tomato']);
}
}
There, problem solved right? But what if we need a gluten free hamburger? What if we want
different toppings... maybe something more generic like:
136
What is DI?
class Hamburger {
private bun: Bun;
private patty: Patty;
private toppings: Toppings;
Okay this is a little different, and it's more flexible in some ways, but it is still quite brittle.
What would happen if the Patty constructor changed to allow for new features? The whole
Hamburger class would have to be updated. In fact, any time any of these constructors used
in Hamburger 's constructor are changed, Hamburger would also have to be changed.
Also, what happens during testing? How can Bun , Patty and Toppings be effectively
mocked?
Taking those concerns into consideration, the class could be rewritten as:
class Hamburger {
private bun: Bun;
private patty: Patty;
private toppings: Toppings;
Now when Hamburger is instantiated it does not need to know anything about its Bun ,
Patty , or Toppings . The construction of these elements has been moved out of the class.
This pattern is so common that TypeScript allows it to be written in shorthand like so:
class Hamburger {
constructor(private bun: Bun, private patty: Patty,
private toppings: Toppings) {}
}
The Hamburger class is now simpler and easier to test. This model of having the
dependencies provided to Hamburger is basic dependency injection.
137
What is DI?
However there is still a problem. How can the instantiation of Bun , Patty and Toppings
best be managed?
This is where dependency injection as a framework can benefit programmers, and it is what
Angular provides with its dependency injection system.
138
DI Framework
DI Framework
So there's a fancy new Hamburger class that is easy to test, but it's currently awkward to
work with. Instantiating a Hamburger requires:
That's a lot of work to create a Hamburger , and now all the different pieces of code that
make Hamburger s have to understand how Bun , Patty and Toppings get instantiated.
One approach to dealing with this new problem might be to make a factory function like so:
function makeHamburger() {
const bun = new Bun();
const patty = new Patty('beef');
const toppings = new Toppings(['lettuce', 'tomato', 'pickles']);
return new Hamburger(bun, patty, toppings);
}
This is an improvement, but when more complex Hamburger s need to be created this factory
will become confusing. The factory is also responsible for knowing how to create four
different components. This is a lot for one function.
This is where a dependency injection framework can help. DI Frameworks have the concept
of an Injector object. An Injector is a lot like the factory function above, but more general,
and powerful. Instead of one giant factory function, an Injector has a factory, or recipe (pun
intended) for a collection of objects. With an Injector , creating a Hamburger could be as
easy as:
139
Angular's DI
Angular's DI
The last example introduced a hypothetical Injector object. Angular simplifies DI even
further. With Angular, programmers almost never have to get bogged down with injection
details.
For example:
@Component({
// ...
})
class ChatWidget {
constructor(private authService: AuthService, private authWidget: AuthWidget,
private chatSocket: ChatSocket) {}
}
@NgModule({
declarations: [ ChatWidget ]
})
export class AppModule {
};
In the above example the AppModule is told about the ChatWidget class. Another way of
saying this is that Angular has been provided a ChatWidget .
That seems pretty straightforward, but astute readers will be wondering how Angular knows
how to build ChatWidget . What if ChatWidget was a string, or a plain function?
What about AuthService , AuthWidget and ChatSocket ? How is ChatWidget getting those?
It's not, at least not yet. Angular does not know about them yet. That can be changed easily
enough:
140
Angular's DI
@Component({
// ...
})
class ChatWidget {
constructor(private authService: AuthService, private authWidget: AuthWidget,
private chatSocket: ChatSocket) {}
}
@Component({
// ...
})
class AuthWidget {}
@Injectable()
class AuthService {}
@Injectable()
class ChatSocket {}
@NgModule({
declarations[ ChatWidget, AuthWidget ]
providers: [ AuthService, ChatSocket ],
})
Okay, this is starting to look a little bit more complete. Although it's still unclear how
ChatWidget is being told about its dependencies. Perhaps that is related to those odd
@Injectable statements.
141
@Inject() and @Injectable
@Inject()
@Inject() is a manual mechanism for letting Angular know that a parameter must be
@Component({
selector: 'app-root',
template: `Encryption: {{ encryption }}`
})
export class AppComponent {
encryption = this.chatWidget.chatSocket.encryption;
In the above we've asked for chatWidget to be the singleton Angular associates with the
class symbol ChatWidget by calling @Inject(ChatWidget) . It's important to note that we're
using ChatWidget for its typings and as a reference to its singleton. We are not using
ChatWidget to instantiate anything, Angular does that for us behind the scenes.
When using TypeScript, @Inject is only needed for injecting primitives. TypeScript's types
let Angular know what to do in most cases. The above example would be simplified in
TypeScript to:
142
@Inject() and @Injectable
@Component({
selector: 'app',
template: `Encryption: {{ encryption }}`
})
export class App {
encryption = this.chatWidget.chatSocket.encryption;
View Example
@Injectable()
@Injectable() lets Angular know that a class can be used with the dependency injector.
@Injectable() is not strictly required if the class has other Angular decorators on it or does
not have any dependencies. What is important is that any class that is going to be injected
with Angular is decorated. However, best practice is to decorate injectables with
@Injectable() , as it makes more sense to the reader.
@Injectable()
export class ChatWidget {
constructor(
public authService: AuthService,
public authWidget: AuthWidget,
public chatSocket: ChatSocket) { }
}
In the above example Angular's injector determines what to inject into ChatWidget 's
constructor by using type information. This is possible because these particular
dependencies are typed, and are not primitive types. In some cases Angular's DI needs
more information than just types.
143
@Inject() and @Injectable
144
Injection Beyond Classes
So far providers have been used with Angular's @NgModule meta in an array. providers
have also all been class identifiers. Angular lets programmers specify providers with a more
verbose "recipe". This is done with by providing Angular an Object literal ( {} ):
@NgModule({
providers: [ { provide: ChatWidget, useClass: ChatWidget } ],
})
export class DiExample {};
This example is yet another example that provide s a class, but it does so with Angular's
longer format.
This long format is really handy. If the programmer wanted to switch out ChatWidget
implementations, for example to allow for a MockChatWidget , they could do this easily:
@NgModule({
providers: [ { provide: ChatWidget, useClass: MockChatWidget } ],
})
export class DiExample {};
The best part of this implementation swap is that the injection system knows how to build
MockChatWidget , and will sort all of that out.
The injector can use more than classes though. useValue and useFactory are two other
examples of provider "recipes" that Angular can use. For example:
145
Injection Beyond Classes
@NgModule({
providers: [ { provide: 'Random', useFactory: randomFactory } ],
})
export class DiExample {};
@Component({
selector: 'app-root',
template: `Random: {{ value }}`
})
export class AppCompoennt {
value: number;
constructor(@Inject('Random') r) {
this.value = r;
}
}
View Example
One important note is that 'Random' is in quotes, both in the provide function and in the
consumer. This is because as a factory we have no Random identifier anywhere to access.
The above example uses Angular's useFactory recipe. When Angular is told to provide
things using useFactory , Angular expects the provided value to be a function. Sometimes
functions and classes are even more than what's needed. Angular has a "recipe" called
useValue for these cases that works almost exactly the same:
@NgModule({
providers: [ { provide: 'Random', useValue: Math.random() } ],
})
export class DiExample {};
View Example
146
Injection Beyond Classes
In this case, the product of Math.random is assigned to the useValue property passed to the
provider .
147
Avoiding Injection Collisions: OpaqueToken
Consider this example where the main application is a consumer of two modules: one that
provides an email service and another that provides a logging service.
app/email/email.service.ts
@Injectable()
export class EmailService {
constructor(@Inject(apiConfig) public apiConfig) { }
}
app/email/email.module.ts
@NgModule({
providers: [ EmailService ],
})
export class EmailModule { }
The email service api requires some configuration settings, identified by the string api-
config , to be provided by the DI system. This module should be flexible enough so that it
can be used by different modules in different applications. This means that those settings
should be determined by the application characteristics and therefore provided by the
AppModule where the EmailModule is imported.
app/logger/logger.service.ts
148
Avoiding Injection Collisions: OpaqueToken
@Injectable()
export class LoggerService {
constructor(@Inject(apiConfig) public apiConfig) { }
}
app/logger/logger.module.ts
@NgModule({
providers: [ LoggerService ],
})
export class LoggerModule { }
The other service, LoggerModule , was created by a different team than the one that created
EmailModule , and it that also requires a configuration object. Not surprisingly, they decided
to use the same token for their configuration object, the string api-config . In an effort to
avoid a collision between the two tokens with the same name, we could try to rename the
imports as shown below. In an effort to avoid a collision between the two tokens with the
same name, we could try to rename the imports as shown below.
app/app.module.ts
@NgModule({
...
providers: [
{ provide: emailApiConfig, useValue: { apiKey: 'email-key', context: 'registration'
} },
{ provide: loggerApiConfig, useValue: { apiKey: 'logger-key' } },
],
...
})
export class AppModule { }
View Example
When the application runs, it encounters a collision problem resulting in both modules
getting the same value for their configuration, in this case { apiKey: 'logger-key' } . When
it comes time for the main application to specify those settings, Angular overwrites the first
emailApiConfig value with the loggerApiConfig value, since that was provided last. In this
149
Avoiding Injection Collisions: OpaqueToken
case, module implementation details are leaking out to the parent module. Not only that,
those details were obfuscated through the module exports and this can lead to problematic
debugging. This is where Angular's OpaqueToken comes into play.
OpaqueToken
OpaqueToken s are unique and immutable values which allow developers to avoid collisions
Here, regardless of whether or not the same value is passed to the constructor of the token,
it will not result in identical symbols.
app/email/email.module.ts
@Injectable()
export class EmailService {
constructor(@Inject(apiConfig) public apiConfig: EmailConfig) { }
}
@Injectable()
export class LoggerService {
constructor(@Inject(apiConfig) public apiConfig: LoggerConfig) { }
}
View Example
After turning the identifying tokens into OpaqueToken s without changing anything else, the
collision is avoided. Every service gets the correct configuration object from the root module
and Angular is now able to differentiate two tokens that uses the same string.
150
Avoiding Injection Collisions: OpaqueToken
151
The Injector Tree
In Angular there is not just one injector per application, there is at least one injector per
application. Injectors are organized in a tree that parallels Angular's component tree.
Consider the following tree, which models a chat application consisting of two open chat
windows, and a login/logout widget.
152
The Injector Tree
153
The Injector Tree
In the image above, there is one root injector, which is established through @NgModule 's
providers array. There's a LoginService registered with the root injector.
Below the root injector is the root @Component . This particular component has no providers
array and will use the root injector for all of its dependencies.
There are also two child injectors, one for each ChatWindow component. Each of these
components has their own instantiation of a ChatService .
There are several grandchild components that have no injectors. There are ChatFeed and
ChatInput components for each ChatWindow . There are also LoginWidget and
The injector tree does not make a new injector for every component, but does make a new
injector for every component with a providers array in its decorator. Components that have
no providers array look to their parent component for an injector. If the parent does not
have an injector, it looks up until it reaches the root injector.
component(s), the dependencies the child receives will shadow the parent dependencies.
This can have all sorts of unintended consequences.
app/module.ts
154
The Injector Tree
@NgModule({
imports: [BrowserModule],
declarations: [
AppComponent,
ChildInheritorComponent,
ChildOwnInjectorComponent,
],
/** Provide dependencies here */
providers: [Unique],
bootstrap: [AppComponent],
})
export class AppModule {}
app/services/unique.ts
@Injectable()
export class Unique {
value = (+Date.now()).toString(16) + '.' +
Math.floor(Math.random() * 500);
}
The Unique service generates a value unique to its instance upon instantiation.
app/components/child-inheritor.component.ts
155
The Injector Tree
@Component({
selector: 'app-child-inheritor',
template: `<span>{{ value }}</span>`
})
export class ChildInheritorComponent {
value = this.u.value;
constructor(private u: Unique) { }
}
The child inheritor has no injector. It will traverse the component tree upwards looking for an
injector.
app/components/child-own-injector.component.ts
@Component({
selector: 'child-own-injector',
template: `<span>{{ value }}</span>`,
providers: [Unique]
})
export class ChildOwnInjectorComponent {
value = this.u.value;
constructor(private u: Unique) { }
}
The child own injector component has an injector that is populated with its own instance of
Unique . This component will not share the same value as the root injector's Unique
instance.
app/containers/app.ts
156
The Injector Tree
@Component({
selector: 'app-root',
template: `
<p>
App's Unique dependency has a value of {{ value }}
</p>
<p>
which should match
</p>
<p>
ChildInheritor's value:
<app-child-inheritor></app-child-inheritor>
</p>
<p>
However,
</p>
<p>
ChildOwnInjector should have its own value:
<app-child-own-injector></app-child-own-injector>
</p>
<p>
ChildOwnInjector's other instance should also have its own value:
<app-child-own-injector></app-child-own-injector>
</p>`,
})
export class AppComponent {
value: number = this.u.value;
constructor(private u: Unique) { }
}
View Example
157
Http
HTTP
In order to start making HTTP calls from our Angular app we need to import the
angular/http module and register for HTTP services. It supports both XHR and JSONP
requests exposed through the HttpModule and JsonpModule respectively. In this section we
will be focusing only on the HttpModule .
Setting up angular/http
In order to use the various HTTP services we need to include HttpModule in the imports for
the root NgModule . This will allow us to access HTTP services from anywhere in the
application.
...
import { AppComponent } from './app.component'
import { HttpModule } from '@angular/http';
@NgModule({
imports: [
BrowserModule,
ReactiveFormsModule,
FormsModule,
HttpModule
],
providers: [SearchService],
declarations: [AppComponent],
bootstrap: [AppComponent]
})
export class AppModule {}
158
Making Requests
@Injectable()
export class SearchService {
search(term: string) {
return this.http
.get('https://api.spotify.com/v1/search?q=' + term + '&type=artist')
.map(response => response.json());
}
}
View Example
Here we are making an HTTP GET request which is exposed to us as an observable. You
will notice the .map operator chained to .get . The Http service provides us with the raw
response as a string. In order to consume the fetched data we have to convert it to JSON.
159
Catching Rejections
Catching Rejections
To catch rejections we use the subscriber's error and complete callbacks.
@Injectable()
export class AuthService {
login(username, password) {
const payload = {
username: username,
password: password
};
160
Catch and Release
@Injectable()
export class SearchService {
search(term: string) {
return this.http.get('https://api.spotify.com/v1/dsds?q=' + term + '&type=artist')
.map((response) => response.json())
.catch((e) => {
return Observable.throw(
new Error(`${ e.status } ${ e.statusText }`)
);
});
}
}
View Example
It also allows us to inspect the error and decide which route to take. For example, if we
encounter a server error then use a cached version of the request otherwise re-throw.
161
Catch and Release
@Injectable()
export class SearchService {
...
search(term: string) {
return this.http.get(`https://api.spotify.com/v1/dsds?q=${term}&type=artist`)
.map(response => response.json())
.catch(e => {
if (e.status >== 500) {
return cachedVersion();
} else {
return Observable.throw(
new Error(`${ e.status } ${ e.statusText }`)
);
}
});
}
}
162
Cancel a Request
Cancel a Request
Cancelling an HTTP request is a common requirement. For example, you could have a
queue of requests where a new request supersedes a pending request and that pending
request needs to be cancelled.
@Component({ /* ... */ })
export class AppComponent {
/* ... */
search() {
const request = this.searchService.search(this.searchField.value)
.subscribe(
result => { this.result = result.artists.items; },
err => { this.errorMessage = err.message; },
() => { console.log('Completed'); }
);
request.unsubscribe();
}
}
View Example
163
Retry
Retry
There are times when you might want to retry a failed request. For example, if the the user is
offline you might want to retry a few times or indefinitely.
Use the RxJS retry operator. It accepts a retryCount argument. If not provided, it will
retry the sequence indefinitely.
Note that the error callback is not invoked during the retry phase. If the request fails it will be
retried and only after all the retry attempts fail the stream throws an error.
164
Retry
@Injectable()
export class SearchService {
search(term: string) {
let tryCount = 0;
return this.http.get('https://api.spotify.com/v1/dsds?q=' + term + '&type=artist')
.map(response => response.json())
.retry(3);
}
}
View Example
165
Search with flatMap
Let's say we wanted to implement an AJAX search feature in which every keypress in a text
field will automatically perform a search and update the page with the results. How would
this look? Well we would have an Observable subscribed to events coming from an input
field, and on every change of input we want to perform some HTTP request, which is also an
Observable we subscribe to. What we end up with is an Observable of an Observable .
By using flatMap we can transform our event stream (the keypress events on the text field)
into our response stream (the search results from the HTTP request).
app/services/search.service.ts
166
Search with flatMap
@Injectable()
export class SearchService {
search(term: string) {
return this.http
.get('https://api.spotify.com/v1/search?q=' + term + '&type=artist')
.map((response) => response.json())
}
}
Here we have a basic service that will undergo a search query to Spotify by performing a get
request with a supplied search term. This search function returns an Observable that has
had some basic post-processing done (turning the response into a JSON object).
OK, let's take a look at the component that will be using this service.
app/app.component.ts
167
Search with flatMap
@Component({
selector: 'app-root',
template: `
<form [formGroup]="coolForm"><input formControlName="search" placeholder="Sear
ch Spotify artist"></form>
this.searchField.valueChanges
.debounceTime(400)
.flatMap(term => this.searchService.search(term))
.subscribe((result) => {
this.result = result.artists.items
});
}
}
View Example
Here we have set up a basic form with a single field, search , which we subscribe to for
event changes. We've also set up a simple binding for any results coming from the
SearchService . The real magic here is flatMap which allows us to flatten our two separate
subscribed Observables into a single cohesive stream we can use to control events coming
from user input and from server responses.
168
Search with flatMap
169
Enhancing Search with switchMap
What if the server, for some reason, takes a very long time to respond to a particular query?
If we use flatMap , we run the risk of getting results back from the server in the wrong order.
Let's illustrate this with an example.
A Quick Example
Consider a situation where we first type in the letters ABC , and suppose the string ABC is
actually a special string where it will take the server a few extra seconds to reply.
Meanwhile, after we paused for a bit (more than the debounce time), we decide to type in
another letter (the letter X) and our app sends a request to the server for the string ABCX .
Since ABCX is not considered a special string, the server replies very quickly and our app
sets the suggestions for ABCX .
A few seconds later, however, the server finally replies with the response for the ABC string,
and our app receives that response and sets the search suggestions for ABC , overwriting
the suggestions for the ABCX string, even though the request for that actually came
afterwards.
--A1----------A2-->
------B1--B2------>
You can see that A2 arrives after B2 even though the A1 request began first. This will end up
showing the wrong results to the user. "If the last input in the search was ABCX why am I
seeing the results for ABC ?" the user might think. To get around this problem we need to
replace flatMap with switchMap .
What is switchMap ?
170
Enhancing Search with switchMap
switchMap is very similar to flatMap , but with a very important distinction. Any events to be
merged into the trunk stream are ignored if a new event comes in. Here is a marble diagram
showing the behavior of switchMap :
In short, every time an event comes down the stream, flatMap will subscribe to (and
invoke) a new observable without unsubscribing from any other observable created by a
previous event. switchMap on the other hand will automatically unsubscribe from any
previous observable when a new event comes down the stream.
In the diagram above, the round "marbles" represent events in the originating stream. In the
resulting stream, "diamonds" mark the creation (and subscription) of an inner observable
(that is eventually merged onto the trunk stream) and "squares" represent values emitted
from that same inner observable.
Just like flatMap , the red marble gets replaced with a red diamond and a subsequent red
square. The interaction between the green and blue marble events are more interesting.
Note that the green marble gets mapped to a green diamond immediately. And if enough
time had passed, a green square would be pushed into the trunk stream but we do not see
that here.
Before the green square event is able to happen, a blue marble comes through and gets
mapped to a blue diamond. What happened is that the green square is now ignored and do
not get merged back into the trunk stream. The behavior of switchMap can be likened to a
171
Enhancing Search with switchMap
flatMap that "switches" to the more immediate incoming event and ignores all previously
In our case, because the blue marble event happened very quickly after the green marble,
we "switched" over to focus on dealing with the blue marble instead. This behavior is what
will prevent the problem we described above.
If we apply switchMap to the above example, the response for ABC would be ignored and
the suggestions for ABCX would remain.
app/app.component.ts
172
Enhancing Search with switchMap
@Component({
selector: 'app-root',
template: `
<form [formGroup]="coolForm"><input formControlName="search" placeholder="Sear
ch Spotify artist"></form>
this.searchField.valueChanges
.debounceTime(400)
.switchMap(term => this.searchService.search(term))
.subscribe((result) => {
this.result = result.artists.items
});
}
}
View Example
This implementation of incremental search with switchMap is more robust than the one we
saw on the previous page with flatMap . The suggestions that the user sees will always
eventually reflect the last thing the user typed. Thanks to this, we can guarantee a great user
experience regardless of how the server responds.
Further Resources
SwitchMap Examples
Egghead Video Tutorial on SwitchMap
173
Enhancing Search with switchMap
174
Requests as Promises
Requests as Promises
The observable returned by Angular http client can be converted it into a promise.
@Injectable()
export class SearchService {
search(term: string) {
return this.http
.get(`https://api.spotify.com/v1/search?q=${term}&type=artist`)
.map((response) => response.json())
.toPromise();
}
}
@Component({ /* ... */ })
export class AppComponent {
/* ... */
search() {
this.searchService.search(this.searchField.value)
.then((result) => {
this.result = result.artists.items;
})
.catch((error) => console.error(error));
}
}
175
Change Detection
Change Detection
Change detection is the process that allows Angular to keep our views in sync with our
models.
Change detection has changed in a big way between the old version of Angular and the new
one. In Angular 1, the framework kept a long list of watchers (one for every property bound
to our templates) that needed to be checked every-time a digest cycle was started. This was
called dirty checking and it was the only change detection mechanism available.
Because by default Angular 1 implemented two way data binding, the flow of changes was
pretty much chaotic, models were able to change directives, directives were able to change
models, directives were able to change other directives and models were able to change
other models.
176
Change Detection
177
Change Detection Strategies in Angular 1 vs Angular 2
Because of the nature of two-way data binding, in Angular 1 there was no guarantee that a
parent node would always be checked before a child node. It was possible that a child node
could change a parent node or a sibling or any other node in the tree, and that in turn would
trigger new updates down the chain. This made it difficult for the change detection
mechanism to traverse all the nodes without falling in a circular loop with the infamous
message:
In Angular, changes are guaranteed to propagate unidirectionally. The change detector will
traverse each node only once, always starting from the root. That means that a parent
component is always checked before its children components.
178
Change Detection Strategies in Angular 1 vs Angular 2
179
How Change Detection Works
We are going to create a simple MovieApp to show information about one movie. This app is
going to consist of only two components: the MovieComponent that shows information about
the movie and the AppComponent which holds a reference to the movie with buttons to
perform some actions.
Our AppComponent will have three properties: the slogan of the app, the title of the
movie and the lead actor . The last two properties will be passed to the MovieComponent
element referenced in the template.
app/app.component.ts
@Component({
selector: 'app-root',
template: `
<h1>MovieApp</h1>
<p>{{ slogan }}</p>
<button type="button" (click)="changeActorProperties()">
Change Actor Properties
</button>
<button type="button" (click)="changeActorObject()">
Change Actor Object
</button>
<app-movie [title]="title" [actor]="actor"></app-movie>`
})
export class AppComponent {
slogan = 'Just movie information';
title = 'Terminator 1';
actor = new Actor('Arnold', 'Schwarzenegger');
changeActorProperties() {
this.actor.firstName = 'Nicholas';
this.actor.lastName = 'Cage';
}
changeActorObject() {
this.actor = new Actor('Bruce', 'Willis');
}
}
180
How Change Detection Works
In the above code snippet, we can see that our component defines two buttons that trigger
different methods. The changeActorProperties will update the lead actor of the movie by
directly changing the properties of the actor object. In contrast, the method
changeActorObject will change the information of the actor by creating a completely new
The Actor model is pretty straightforward, it is just a class that defines the firstName and
the lastName of an actor.
app/actor.model.ts
Finally, the MovieComponent shows the information provided by the AppComponent in its
template.
app/movie.component.ts
@Component({
selector: 'app-movie',
template: `
<div>
<h3>{{ title }}</h3>
<p>
<label>Actor:</label>
<span>{{actor.firstName}} {{actor.lastName}}</span>
</p>
</div>`
})
export class MovieComponent {
@Input() title: string;
@Input() actor: Actor;
}
View Example
181
Change Detector Classes
The goal of the change detectors is to know which model properties used in the template of
a component have changed since the last time the change detection process ran.
In order to know that, Angular creates an instance of the appropriate change detector class
and a link to the component that it's supposed to check.
In our example, because we only have one instance of the AppComponent and the
MovieComponent , we will have only one instance of the AppComponent_ChangeDetector and the
MovieComponent_ChangeDetector .
class AppComponent_ChangeDetector {
constructor(
public previousSlogan: string,
public previousTitle: string,
public previousActor: Actor,
public movieComponent: MovieComponent
) {}
182
Change Detector Classes
Because in the template of our AppComponent we reference three variables ( slogan , title
and actor ), our change detector will have three properties to store the "old" values of these
three properties, plus a reference to the AppComponent instance that it's supposed to
"watch". When the change detection process wants to know if our AppComponent instance
has changed, it will run the method detectChanges passing the current model values to
compare with the old ones. If a change was detected, the component gets updated.
Disclaimer: This is just a conceptual overview of how change detector classes work; the
actual implementation may be different.
app/movie.component.ts
@Component({
// ...
changeDetection: ChangeDetectionStrategy.Default
})
export class MovieComponent {
// ...
}
View Example
Let's see what happens when a user clicks the button "Change Actor Properties" when using
the Default strategy.
As noted previously, changes are triggered by events and the propagation of changes is
done in two phases: the application phase and the change detection phase.
Phase 1 (Application):
In the first phase, the application (our code) is responsible for updating the models in
response to some event. In this scenario, the properties actor.firstName and
actor.lastName are updated.
183
Change Detector Classes
Now that our models are updated, Angular must update the templates using change
detection.
Change detection always starts at the root component, in this case the AppComponent , and
checks if any of the model properties bound to its template have changed, comparing the old
value of each property (before the event was triggered) to the new one (after the models
were updated). The AppComponent template has a reference to three properties, slogan ,
title and actor , so the comparison made by its corresponding change detector will look
like:
Notice that even if we change the properties of the actor object, we are always working
with the same instance. Because we are doing a shallow comparison, the result of asking if
actor !== previousActor will always be false even when its internal property values have
indeed changed. Even though the change detector was unable to find any change, the
default strategy for the change detection is to traverse all the components of the tree
even if they do not seem to have been modified.
Next, change detection moves down in the component hierarchy and check the properties
bound to the MovieComponent 's template doing a similar comparison:
Finally, Angular has detected that some of the properties bound to the template have
changed so it will update the DOM to get the view in sync with the model.
Performance Impact
Traversing all the tree components to check for changes could be costly. Imagine that
instead of just having one reference to <app-movie> inside our AppComponent 's template, we
have multiple references?
If our movie list grows too big, the performance of our system will start degrading. We can
narrow the problem to one particular comparison:
184
Change Detector Classes
As we have learned, this result is not very useful because we could have changed the
properties of the object without changing the instance, and the result of the comparison will
always be false . Because of this, change detection is going to have to check every child
component to see if any of the properties of that object ( firstName or lastName ) have
changed.
What if we can find a way to indicate to the change detection that our MovieComponent
depends only on its inputs and that these inputs are immutable? In short, we are trying to
guarantee that when we change any of the properties of the actor object, we end up with a
different Actor instance so the comparison actor !== previousActor will always return
true . On the other hand, if we did not change any property, we are not going to create a
If the above condition can be guaranteed (create a new object every time any of its
properties changes, otherwise we keep the same object) and when checking the inputs of
the MovieComponent has this result:
then we can skip the internal check of the component's template because we are now
certain that nothing has changed internally and there's no need to update the DOM. This will
improve the performance of the change detection system because fewer comparisons have
to be made to propagate changes through the app.
185
Change Detection Strategy: OnPush
app/movie.component.ts
@Component({
// ...
changeDetection: ChangeDetectionStrategy.OnPush
})
export class MovieComponent {
// ...
}
View Example
This will inform Angular that our component only depends on its inputs and that any object
that is passed to it should be considered immutable. This time when we click the "Change
Actor Properties" button nothing changes in the view.
Let's follow the logic behind it again. When the user clicks the button, the method
changeActorProperties is called and the properties of the actor object get updated.
When the change detection analyzes the properties bound to the AppComponent 's template,
it will see the same picture as before:
But this time, we explicitly told Angular that our component only depends on its inputs and all
of them are immutable. Angular then assumes that the MovieComponent hasn't changed and
will skip the check for that component. Because we didn't force the actor object to be
immutable, we end up with our model out of sync with the view.
Let's rerun the app but this time we will click the "Change Actor Object" button. This time, we
are creating a new instance of the Actor class and assigning it to the this.actor object.
When change detection analyzes the properties bound to the AppComponent 's template it will
find:
186
Change Detection Strategy: OnPush
Because change detection now knows that the actor object changed (it's a new instance) it
will go ahead and continue checking the template for MovieComponent to update its view. At
the end, our templates and models are in sync.
187
Enforcing Immutability
Enforcing Immutability
We cheated a little in the previous example. We told Angular that all of our inputs, including
the actor object, were immutable objects, but we went ahead and updated its properties,
violating the immutability principle. As a result we ended up with a sync problem between
our models and our views. One way to enforce immutability is using the library Immutable.js.
Because in JavaScript primitive types like string and number are immutable by definition,
we should only take care of the objects we are using. In this case, the actor object.
Here's an example comparing a mutable type like an array to an immutable type like a
string :
var a = 'Car';
a[0] = 'B';
console.log(a); // 'Car' => The first letter didn't change, strings are immutable
Then in our AppComponent we import the library and use it to create an actor object as an
immutable.
app/app.component.ts
188
Enforcing Immutability
@Component({
selector: 'app-root',
template: `
<h1>MovieApp</h1>
<p>{{ slogan }}</p>
<button type="button" (click)="changeActor()">
Change Actor
</button>
<app-movie [title]="title" [actor]="actor"></app-movie>`
})
export class AppComponent {
slogan = 'Just movie information';
title = 'Terminator 1';
actor = Immutable.Map({
firstName: 'Arnold',
lastName: 'Schwarzenegger'
})
changeActor() {
this.actor = this.actor.merge({ firstName: 'Nicholas', lastName: 'Cage' });
}
}
Because we are always getting a new object when we try to change the actor , there's no
point in having two different methods in our component. We removed the methods
changeActorProperties and changeActorObject and created a new one called changeActor .
app/movie.component.ts
189
Enforcing Immutability
@Component({
selector: 'app-movie',
template: `
<div>
<h3>{{ title }}</h3>
<p>
<label>Actor:</label>
<span>{{ actor.get('firstName') }} {{ actor.get('lastName') }}</span>
</p>
</div>`,
changeDetection: ChangeDetectionStrategy.OnPush
})
export class MovieComponent {
@Input() title: string;
@Input() actor: Immutable.Map<string, string>;
}
View Example
Using this pattern we are taking full advantage of the "OnPush" change detection strategy
and thus reducing the amount of work done by Angular to propagate changes and to get
models and views in sync. This improves the performance of the application.
190
Additional Resources
Additional Resources
To learn more about change detection, visit the following links (in order of relevance):
191
Zone.js
Zones
Zone.js provides a mechanism, called zones, for encapsulating and intercepting
asynchronous activities in the browser (e.g. setTimeout , , promises).
These zones are execution contexts that allow Angular to track the start and completion of
asynchronous activities and perform tasks as required (e.g. change detection). Zone.js
provides a global zone that can be forked and extended to further encapsulate/isolate
asynchronous behaviour, which Angular does so in its NgZone service, by creating a fork
and extending it with its own behaviours.
The NgZone service provides us with a number of Observables and methods for
determining the state of Angular's zone and to execute code in different ways inside and
outside Angular's zone.
between external libraries and Angular. In some cases, it may be preferential to execute
third party methods outside of Angular's zone (see below).
In The Zone
NgZone exposes a set of Observables that allow us to determine the current status, or
stability, of Angular's zone.
onUnstable Notifies when code has entered and is executing within the Angular zone.
onMicrotaskEmpty - Notifies when no more microtasks are queued for execution.
Angular subscribes to this internally to signal that it should run change detection.
onStable Notifies when the last onMicroTaskEmpty has run, implying that all tasks
have completed and change detection has occurred.
onError Notifies when an error has occurred. Angular subscribes to this internally to
send uncaught errors to its own error handler, i.e. the errors you see in your console
prefixed with 'EXCEPTION:'.
192
Zone.js
@Injectable()
export class OurZoneWatchingService() {
constructor(private ngZone: NgZone) {
this.ngZone.onStable.subscribe(this.onZoneStable);
this.ngZone.onUnstable.subscribe(this.onZoneUnstable);
this.ngZone.onError.subscribe(this.onZoneError);
}
onZoneStable() {
console.log('We are stable');
}
onZoneUnstable() {
console.log('We are unstable');
}
onZoneError(error) {
console.error('Error', error instanceof Error ? error.message : error.toString());
}
}
Subscribing to these can help you determine if your code is unexpectedly triggering change
detection as a result of operations that do not affect application state.
Change Detection
Since all asynchronous code executed from within Angular's zone can trigger change
detection you may prefer to execute some code outside of Angular's zone when change
detection is not required.
To run code outside of Angular's context, NgZone provides a method aptly named
runOutsideAngular. Using this method, Angular's zone will not interact with your code and
will not receive events when the global zone becomes stable.
In this example you will see in the log what happens with Angular's zone when code is run in
and outside of it.
You will notice that in both cases clicking the button causes the Angular zone to become
unstable due to Zone.js patching and watching HTMLElement.prototype.onclick, however
the setInterval executing outside of Angular's zone does not affect its stability and does not
trigger change detection.
Debugging
193
Zone.js
Generally, exceptions thrown during a chain of asynchronous events will only include the
current method in their stack trace.
With Zone.js tracking all of our asynchronous calls it can provide us a longer, more detailed,
stack trace of the events and calls that occurred leading up to our exception.
To enable long stack traces in development, you should include the long-stack-trace-zone
module in your code. It is a good idea not to include this in your production build but Angular
will skip setting up longer stack traces when in production mode ( enableProdMode from
@angular/core ).
Angular will take care of forking and extending its own zone to display more meaningful
stack traces.
if (__PRODUCTION__) {
enableProdMode();
} else {
require('zone.js/dist/long-stack-trace-zone');
}
With the following code, we start by calling startAsync which triggers a chain of
setTimeouts leading up to an uncaught error.
function startAsync() {
setTimeout(stepOne, 100);
}
function stepOne() {
setTimeout(stepTwo, 100);
}
function stepTwo() {
throw new Error('Finished');
}
194
Zone.js
In the stack trace below, you can see the order of events that occurred within this
asynchronous chain of function calls, '>>' has been added to point out our functions.
You'll notice this stack trace includes much more information, including Zone's own task
management (e.g. onScheduleTask ), as well as the time that elapsed between when the
function was queued and when it was executed.
Having this longer stack trace may aide you with debugging which feature of Angular your
code is interacting with asynchronously and help you narrow down where your problem is
occuring.
195
Zone.js
196
Advanced Angular
Advanced Angular
Angular gives us access to most of the core entities it uses in its architecture. Now that we
understand the different parts involved in an Angular application, let's dig deeper into some
of these entities and take advantage of what we know.
197
Directives
Angular Directives
Angular built-in directives cover a broad range of functionality, but sometimes creating our
own directives will result in more elegant solutions.
198
Creating an Attribute Directive
@Component({
selector: 'app-visit-rangle',
template: `
<button
type="button"
(click)="visitRangle()">
Visit Rangle
</button>
`
})
export class VisitRangleComponent {
visitRangle() {
location.href = 'https://rangle.io';
}
}
View Example
We're polite, so rather than just sending the user to a new page, we're going to ask if they're
ok with that first by creating an attribute directive and attaching that to the button.
@Directive({
selector: `[appConfirm]`
})
export class ConfirmDirective {
@HostListener('click', ['$event'])
confirmFirst(event: Event) {
return window.confirm('Are you sure you want to do this?');
}
View Example
Directives are created by using the @Directive decorator on a class and specifying a
selector. For directives, the selector name must be camelCase and wrapped in square
brackets to specify that it is an attribute binding. We're using the @HostListener decorator to
listen in on events on the component or element it's attached to. In this case we're watching
the click event and passing in the event details which are given by the special $event
keyword. Next, we want to attach this directive to the button we created earlier.
199
Creating an Attribute Directive
template: `
<button
type="button"
(click)="visitRangle()"
appConfirm>
Visit Rangle
</button>
`
View Example
Notice, however, that the button doesn't work quite as expected. That's because while we're
listening to the click event and showing a confirm dialog, the component's click handler runs
before the directive's click handler and there's no communication between the two. To do
this we'll need to rewrite our directive to work with the component's click handler.
@Directive({
selector: `[appConfirm]`
})
export class ConfirmDirective {
@Input() appConfirm = () => {};
@HostListener('click', ['$event'])
confirmFirst() {
const confirmed = window.confirm('Are you sure you want to do this?');
if(confirmed) {
this.appConfirm();
}
}
}
View Example
Here, we want to specify what action needs to happen after a confirm dialog's been sent out
and to do this we create an input binding just like we would on a component. We'll use our
directive name for this binding and our component code changes like this:
<button
type="button"
[appConfirm]="visitRangle">
Visit Rangle
</button>
View Example
200
Creating an Attribute Directive
Now our button works just as we expected. We might want to be able to customize the
message of the confirm dialog however. To do this we'll use another binding.
@Directive({
selector: `[appConfirm]`
})
export class ConfirmDirective {
@Input() appConfirm = () => {};
@Input() confirmMessage = 'Are you sure you want to do this?';
@HostListener('click', ['$event'])
confirmFirst() {
const confirmed = window.confirm(this.confirmMessage);
if(confirmed) {
this.appConfirm();
}
}
}
View Example
Our directive gets a new input property that represents the confirm dialog message, which
we pass in to window.confirm call. To take advantage of this new input property, we add
another binding to our button.
<button
type="button"
[appConfirm]="visitRangle"
confirmMessage="Click ok to visit Rangle.io!">
Visit Rangle
</button>
View Example
Now we have a button with a customizable confirm message before it moves you to a new
url.
201
Creating an Attribute Directive
@Directive({
selector: '[appMyDirective]'
})
class MyDirective {
@HostListener('click', ['$event'])
onClick() {}
}
We can also respond to external events, such as from window or document , by adding the
target in the listener.
@Directive({
selector: `[appHighlight]`
})
export class HighlightDirective {
constructor(private el: ElementRef, private renderer: Renderer) { }
@HostListener('document:click', ['$event'])
handleClick(event: Event) {
if (this.el.nativeElement.contains(event.target)) {
this.highlight('yellow');
} else {
this.highlight(null);
}
}
highlight(color) {
this.renderer.setElementStyle(this.el.nativeElement, 'backgroundColor', color);
}
}
View Example
Although less common, we can also use @HostListener if we'd like to register listeners
on the host element of a Component.
Host Elements
202
Creating an Attribute Directive
For a directive, the concept is fairly straight forward. Whichever template tag you place your
directive attribute on is considered the host element. If we were implementing the
HighlightDirective above like so:
<div>
<p appHighlight>
<span>Text to be highlighted</span>
</p>
</div>
The <p> tag would be considered the host element. If we were using a custom
TextBoxComponent as the host, the code would look like this:
<div>
<app-my-text-box appHighlight>
<span>Text to be highlighted</span>
</app-my-text-box>
</div>
In the context of a Component, the host element is the tag that you create through the
selector string in the component configuration. For the TextBoxComponent in the example
above, the host element in the context of the component class would be the <app-my-text-
box> tag.
203
Creating an Attribute Directive
For example, lets say that we want to create a directive for buttons that dynamically adds a
class when we press on it. That could look something like:
@Directive({
selector: '[appButtonPress]'
})
export class ButtonPressDirective {
@HostBinding('attr.role') role = 'button';
@HostBinding('class.pressed') isPressed: boolean;
@HostListener('mousedown') hasPressed() {
this.isPressed = true;
}
@HostListener('mouseup') hasReleased() {
this.isPressed = false;
}
}
Notice that for both use cases of @HostBinding we are passing in a string value for which
property we want to affect. If we don't supply a string to the decorator, then the name of the
class member will be used instead.
In the first @HostBinding , we are statically setting the role attribute to button . For the
second example, the pressed class will be applied when isPressed is true.
204
Creating a Structural Directive
@Directive({
selector: '[appDelay]'
})
export class DelayDirective {
constructor(
private templateRef: TemplateRef<any>,
private viewContainerRef: ViewContainerRef
) { }
@Input()
set appDelay(time: number): void { }
}
View Example
We use the same @Directive class decorator as attribute directives and define a selector in
the same way. One big difference here is that due to the nature of structural directives being
bound to a template, we have access to TemplateRef , an object representing the template
tag the directive is attached to. We also add an input property in a similar way, but this time
with a set handler so we can execute some code when Angular performs the binding. We
bind delay in exactly the same way as the Angular built-in structural directives.
@Component({
selector: 'app-root',
template: `
<div *ngFor="let item of [1,2,3,4,5,6]">
<card *appDelay="500 * item">
{{item}}
</card>
</div>
`
})
export class AppComponent {
}
View Example
205
Creating a Structural Directive
Notice that no content is being rendered however. This is due to Angular simulating the html
template tag and not rendering any child elements by default. To be able to get this content
to render, we'll have to attach the template given by TemplateRef as an embedded view to a
view container.
206
Creating a Structural Directive
Two types of views can be attached to a view container: Host Views which are linked to a
Component, and Embedded Views which are linked to a template. Since structural directives
interact with templates, we are interested in using Embedded Views in this case.
@Directive({
selector: '[appDelay]'
})
export class DelayDirective {
constructor(
private templateRef: TemplateRef<any>,
private viewContainerRef: ViewContainerRef
) { }
@Input()
set appDelay(time: number): void {
setTimeout(
() => {
this.viewContainerRef.createEmbeddedView(this.templateRef);
},
time);
}
}
View Example
207
Creating a Structural Directive
may not run after the exact time we provided. We'll capture the exact time it loads and make
that variable available in the template.
@Directive({
selector: '[appDelay]'
})
export class DelayDirective {
constructor(
private templateRef: TemplateRef<DelayContext>,
private viewContainerRef: ViewContainerRef
) { }
@Input()
set appDelay(time: number): void {
setTimeout(
() => {
this.viewContainerRef.createEmbeddedView(
this.templateRef,
new DelayContext(performance.now())
);
},
time);
}
}
View Example
We've made a few changes to our appDelay directive. We've created a new DelayContext
class that contains the context that we want to provide to our directive. In this case, we want
to capture the actual time the createEmbeddedView call occurs and make that available as
loadTime in our directive. We've also provided our new class as the generic argument to
the TemplateRef function. This enables static analysis and lets us make sure our calls to
createEmbeddedView pass in a variable of type DelayContext . In our createEmbeddedView
call we pass in our variable which has captured the time of the method call.
208
Creating a Structural Directive
In the component using appDelay , we access the loadTime context variable in the same
way we access variables in ngFor .
@Component({
selector: 'app-root',
template: `
<div *ngFor="let item of [1,2,3,4,5,6]">
<card *delay="500 * item; let loaded = loadTime">
<div class="main">{{item}}</div>
<div class="sub">{{loaded | number:'1.4-4'}}</div>
</card>
</div>
`
})
View Example
209
AoT
AoT in Angular
Every Angular application requires a compilation process before they can run in the browser:
the enriched components and templates provided by Angular cannot be understood by the
browser directly. During the compilation, Angular's compiler also improves the app run-time
performance by taking JavaScript VM's feature (like inline caching) into consideration.
The initial compiler in Angular 1.x and Angular 2 is called JiT (Just-in-Time) compiler. As for
AoT, it stands for the Ahead-of-Time compiler that was recently introduced in Angular.
Compared to the JiT compilation performed by Angular at run-time, AoT provides a smaller
bundle with faster rendering in the browser. Using AoT, we can reduce the angular2-starter
to 428.8 kb compared to the original 1.2 MB and reduce loading times by skipping
compilation in the browser.
The gist of AoT is moving the compilation from run-time to the building process. That means,
first we can remove the JiT compiler (which is around 523kb) from the bundle to have a
smaller build, and second, the browser can execute the code without waiting for JiT in the
run-time which leads to a faster rendering speed.
Early compilation also means that developers can find template bugs without actually
running the code and before it reaches to client. This provides a more robust application with
higher security because less client-side HTML and JavaScript are eval ed. Also, by
introducing compiled code in the building process, AoT makes the application more tree-
shakable and open to various other optimizations. Bundlers like Rollup and Google Closure
can take that advantage and effectively decrease the bundle size.
Besides, AoT compiler also inlines HTML templates and CSS files and help reduce the
amount of asynchronous requests sent by the application. (Note: this caused a config bug
that we will mention in a latter section)
210
AoT
211
AoT limitations
AoT limitations
However, AoT is not perfect. The main limitation is that AoT, due to the way it compiles the
raw code, cannot be used with common code patterns, for example, default exports from
modules, template literals for templates, and functions in providers, routes, or declarations.
Currently, we do not have a complete list of "AoT Do's and Don'ts" and the Angular team has
not released anything regarding this issue. Rangle made its own list here and also provides
a sandbox for testing features with AoT.
Another problem with AoT is that when the application reaches certain complexity, the AoT
bundle compared to JiT bundle can actually takes up more space. As an trade-off of having
a simpler logic for browser (therefore faster rendering speed), the code generated by AoT is
actually more verbose compared to "dynamic" JiT.
212
AoT Configuration
AoT Configuration
To enable AoT in Angular, there are two possible methods:
We recommend the second way because it fits the Angular + Webpack toolchain the best.
One problem of using raw ngc is that ngc tries to inline CSS while lacking necessary
context. For example, the @import 'basscss-basic' statement in index.css would cause
an error like Error: Compilation failed. Resource file not found with ngc . It lacks the
information that 'basscss-basic' is actually a node module inside node_modules . On the
other hand, @ngtools/webpack provides AotPlugin and loader for Webpack which shares
the context with other loaders/plugins. So when ngc is called by @ngtools/webpack , it can
gather necessary informations from other plugins like postcss-import to correctly
understand things like @import 'basscss-basic' .
Config @ngtools/webpack
First, get @ngtools/webpack from npm and save it as a development dependency:
Then, inside the Webpack configuration file (usually named as webpack.config.js ), add
following code:
213
AoT Configuration
exports = { /* ... */
module: {
rules: [
{
test: /\.ts$/,
loader: '@ngtools/webpack',
}
]
},
plugins: [
new AotPlugin({
tsConfigPath: 'path/to/tsconfig.json',
entryModule: 'path/to/app.module#AppModule'
})
]
}
(Note, for project generated by angular-cli , turning on AoT can be simple as ng build --
aot , but since angular-cli does not allow customized webpack configuration for complex use
214
Immutable.js
Immutable.js
Immutable.js is a library that provides immutable generic collections.
215
What is Immutability?
What is Immutability?
Immutability is a design pattern where something can't be modified after being instantiated.
If we want to change the value of that thing, we must recreate it with the new value instead.
Some JavaScript types are immutable and some are mutable, meaning their value can
change without having to recreate it. Let's explain this difference with some examples:
let movie = {
name: 'Star Wars',
episode: 7
};
movie.episode = 8;
console.log(myEp); // outputs 7
As you can see in this case, although we changed the value of movie.episode , the value of
myEp didn't change. That's because movie.episode 's type, number , is immutable.
let movie1 = {
name: 'Star Wars',
episode: 7
};
movie2.episode = 8;
console.log(movie1.episode); // outputs 8
In this case however, changing the value of episode on one object also changed the value of
the other. That's because movie1 and movie2 are of the Object type, and Objects are
mutable.
Boolean
Number
String
Symbol
Null
216
What is Immutability?
Undefined
Object
Array
Function
String's an unusual case, since it can be iterated over using for...of and provides numeric
indexers just like an array, but doing something like:
This will throw an error in strict mode and fail silently in non-strict mode.
217
The Case for Immutability
Dealing with that kind of behavior on a small scale might be manageable, but this can show
up all over an application and can be a real headache as the application gets bigger with
more interactions and more complex logic.
Immutability attempts to solve this by making sure that any object referenced in one part of
the code can't be changed by another part of the code unless they have the ability to rebind
it directly.
218
JavaScript Solutions
JavaScript Solutions
Some new features have been added in ES6 that allow for easier implementation of
immutable data patterns.
219
Object.assign
Object.assign
Object.assign lets us merge one object's properties into another, replacing values of
properties with matching names. We can use this to copy an object's values without altering
the existing one.
let movie1 = {
name: 'Star Wars',
episode: 7
};
movie2.episode = 8;
console.log(movie1.episode); // writes 7
console.log(movie2.episode); // writes 8
As you can see, although we have some way of copying an object, we haven't made it
immutable, since we were able to set the episode's property to 8. Also, how do we modify
the episode property in this case? We do that through the assign call:
let movie1 = {
name: 'Star Wars',
episode: 7
};
console.log(movie1.episode); // writes 7
console.log(movie2.episode); // writes 8
220
Object.freeze
Object.freeze
Object.freeze allows us to disable object mutation.
let movie1 = {
name: 'Star Wars',
episode: 7
};
console.log(movie1.episode); // writes 7
console.log(movie2.episode); // writes 7
One problem with this pattern, however, is how much more verbose our code is and how
difficult it is to read and understand what's actually going on with our data with all of the
boilerplate calls to Object.freeze and Object.assign . We need some more sensible
interface to create and interact with immutable data, and that's where Immutable.js fits in.
Object.freeze is also very slow and should not be used with large arrays.
221
Immutable.js Basics
Immutable.js Basics
To solve our mutability problem, Immutable.js must provide immutable versions of the two
core mutable types, Object and Array.
222
Immutable.Map
Immutable.Map
Map is the immutable version of JavaScript's object structure. Due to JavaScript objects
having the concise object literal syntax, it's often used as a key-value store with key being
type string . This pattern closely follows the map data structure. Let's revisit the previous
example, but use Immutable.Map instead.
console.log(movie1.get('episode')); // writes 7
console.log(movie2.get('episode')); // writes 8
To get the value of a property, we call the get method, passing the property name we want,
like how we'd use an object's string indexer.
To set the value of a property, we call the set method, passing the property name and the
new value. Note that it won't mutate the existing Map object - it returns a new object with the
updated property, so we must rebind the movie2 variable to the new object.
223
Immutable.Map
Map.merge
Sometimes we want to update multiple properties. We can do this using the merge method.
console.log(submitButton);
// writes { text: 'Submit', state: 'active', width: 200, height: 30 }
224
Nested Objects
Nested Objects
Immutable.Map wraps objects shallowly, meaning if you have an object with properties
movie.get('actors').pop();
movie.get('mpaa').rating = 'PG';
console.log(movie.toObject());
/* writes
{ name: 'Star Wars',
episode: 7,
actors: [ { name: 'Daisy Ridley', character: 'Rey' } ],
mpaa: { rating: 'PG', reason: 'sci-fi action violence' } }
*/
225
Nested Objects
movie.get('actors').pop();
movie.get('mpaa').rating = 'PG';
console.log(movie.toObject());
/* writes
{ name: 'Star Wars',
episode: 7,
actors: List [ Map { "name": "Daisy Ridley", "character": "Rey" }, Map { "name": "Ha
rrison Ford", "character": "Han Solo" } ],
mpaa: Map { "rating": "PG-13", "reason": "sci-fi action violence" } }
*/
So let's say you want to modify movie.mpaa.rating . You might think of doing something like
this: movie = movie.get('mpaa').set('rating', 'PG') . However, set will always return the
calling Map instance, which in this case returns the Map bound to the mpaa key rather than
the movie you wanted. We must use the setIn method to update nested properties.
226
Nested Objects
movie = movie
.update('actors', actors => actors.pop())
.setIn(['mpaa', 'rating'], 'PG');
console.log(movie.toObject());
/* writes
{ name: 'Star Wars',
episode: 7,
actors: List [ Map { "name": "Daisy Ridley", "character": "Rey" } ],
mpaa: Map { "rating": "PG", "reason": "sci-fi action violence" } }
*/
We also added a call to Map.update which, unlike set , accepts a function as the second
argument instead of a value. This function accepts the existing value at that key and must
return the new value of that key.
227
Nested Objects
Deleting Keys
Keys can be deleted from maps using the Map.delete and Map.deleteIn methods.
movie = movie.delete('mpaa');
console.log(movie.toObject());
/* writes
{ name: 'Star Wars',
episode: 7,
actors: List [ Map { "name": "Daisy Ridley", "character": "Rey" }, Map { "name": "Ha
rrison Ford", "character": "Han Solo" } ] }
*/
228
Nested Objects
return providedFeatures;
}, []);
229
Immutable.List
Immutable.List
List is the immutable version of JavaScript's array structure.
movies = movies.push(Immutable.Map({
name: 'The Return of the King',
released: 2003
}));
movies = movies.zipWith(
(movie, seriesNumber) => movie.set('episode', seriesNumber),
Immutable.Range(1, movies.size + 1) // size property instead of length
);
console.log(movies);
/* writes
List [
Map { "name": "The Fellowship of the Ring", "released": 2001, "rating": 8.8, "episod
e": 1 },
Map { "name": "The Two Towers", "released": 2002, "rating": 8.7, "episode": 2 },
Map { "name": "The Return of the King", "released": 2003, "rating": 8.9, "episode":
3 } ]
*/
Here we use the Immutable.fromJS call again since we have objects stored in the array. We
call push to add items to the list, just like we would call it on an array. But since we're
creating a new copy, we must rebind the variable. We have the same set and update
calls when we want to update items at specific indexes. We also have access to array
functions like map , reduce with support for extras like the one we're using here, zipWith .
230
Immutable.List
231
Performance and Transient Changes
Performance
Immutable data structures often have a performance penalty due to the costs of allocation
new memory and copying data. Consider these two examples, one which uses a mutable
array and one which uses an Immutable.js collection.
Mutable
Immutable.Range(0, 1000000)
.forEach(function() {
val += "concatenation";
list.push(val);
});
Immutable
const init = {
list: Immutable.List(),
val: ""
};
return {
list: reduced.list.push(next),
val: next
};
}, init).list
Here the fully immutable code runs around 90% slower than the mutable code! While
immutable data can make code much easier to reason about, there is definitely a cost
associated with that decision. As we can see here for iterative concat, this can have a major
impact on usability. Fortunately, Immutable.js provides some features where the
performance costs can be mitigated.
232
Performance and Transient Changes
This transient list builder is still much slower than our fully mutable implementation but much
faster than our fully immutable version.
233
Official Documentation
Official documentation
For more information on Immutable.js, visit the official documentation at
https://facebook.github.io/immutable-js/.
234
Pipes
Pipes
Angular 2 provides a new way of filtering data: pipes . Pipes are a replacement for Angular
1.x's filters . Most of the built-in filters from Angular 1.x have been converted to Angular 2
pipes; a few other handy ones have been included as well.
235
Using Pipes
Using Pipes
Like a filter, a pipe also takes data as input and transforms it to the desired output. A basic
example of using pipes is shown below:
@Component({
selector: 'product-price',
template: `<p>Total price of product is {{ price | currency }}</p>`
})
export class ProductPrice {
price = 100.1234;
}
View Example
Passing Parameters
A pipe can accept optional parameters to modify the output. To pass parameters to a pipe,
simply add a colon and the parameter value to the end of the pipe expression:
pipeName: parameterValue
@Component({
selector: 'app-root',
template: '<p>Total price of product is {{ price | currency: "CAD": true: "1.2-4"
}}</p>'
})
export class AppComponent {
price = 100.123456;
}
View Example
236
Using Pipes
Chaining Pipes
We can chain pipes together to make use of multiple pipes in one expression.
@Component({
selector: 'app-root',
template: '<p>Total price of product is {{ price | currency: "CAD": true: "1.2-4"
| lowercase }}</p>'
})
export class ProductPrice {
price = 100.123456;
}
View Example
237
Custom Pipes
Custom Pipes
Angular allows you to create your own custom pipes:
const FILE_SIZE_UNITS = ['B', 'KB', 'MB', 'GB', 'TB', 'PB', 'EB', 'ZB', 'YB'];
const FILE_SIZE_UNITS_LONG = ['Bytes', 'Kilobytes', 'Megabytes', 'Gigabytes', 'Pettaby
tes', 'Exabytes', 'Zettabytes', 'Yottabytes'];
@Pipe({
name: 'formatFileSize'
})
export class FormatFileSizePipe implements PipeTransform {
transform(sizeInBytes: number, longForm: boolean): string {
const units = longForm
? FILE_SIZE_UNITS_LONG
: FILE_SIZE_UNITS;
have the @Pipe decorator with pipe metadata that has a name property. This value will
be used to call this pipe in template expressions. It must be a valid JavaScript identifier.
implement the PipeTransform interface's transform method. This method takes the
value being piped and a variable number of arguments of any type and return a
transformed ("piped") value.
Each colon-delimited parameter in the template maps to one method argument in the same
order.
238
Custom Pipes
@Component({
selector: 'app-root',
template: `
<div>
<p *ngFor="let f of fileSizes">{{ f | formatFileSize }}</p>
<p>{{ largeFileSize | formatFileSize:true }}</p>
</div>`
})
export class AppComponent {
fileSizes = [10, 100, 1000, 10000, 100000, 10000000, 10000000000];
largeFileSize = Math.pow(10, 15)
}
View Example
239
Stateful Pipes
Stateful Pipes
There are two categories of pipes:
Stateless pipes are pure functions that flow input data through without remembering
anything or causing detectable side-effects. Most pipes are stateless. The
CurrencyPipe we used and the length pipe we created are examples of a stateless
pipe.
Stateful pipes are those which can manage the state of the data they transform. A pipe
that creates an HTTP request, stores the response and displays the output, is a stateful
pipe. Stateful Pipes should be used cautiously.
AsyncPipe
AsyncPipe can receive a Promise or Observable as input and subscribe to the input
automatically, eventually returning the emitted value(s). It is stateful because the pipe
maintains a subscription to the input and its returned values depend on that subscription.
@Component({
selector: 'app-root',
template: `
<p>Total price of product is {{fetchPrice | async | currency:"CAD":true:"1.2-2"}}<
/p>
<p>Seconds: {{seconds | async}} </p>
`
})
export class AppComponent {
fetchPrice = new Promise((resolve, reject) => {
setTimeout(() => resolve(10), 500);
});
seconds = Observable.of(0).concat(Observable.interval(1000))
}
View Example
240
Stateful Pipes
Pipes are stateless by default. We must declare a pipe to be stateful by setting the pure
property of the @Pipe decorator to false. This setting tells Angulars change detection
system to check the output of this pipe each cycle, whether its input has changed or not.
Observable.interval(100)
.take(difference)
.subscribe(() => {
this.currentNumber++;
})
}
return this.currentNumber;
}
}
View Example
241
Forms
Forms
An application without user input is just a page. Capturing input from the user is the
cornerstone of any application. In many cases, this means dealing with forms and all of their
complexities.
Angular 2 is much more flexible than Angular 1.x for handling forms we are no longer
restricted to relying solely on ngModel . Instead, we are given degrees of simplicity and
power, depending on the form's purpose.
Template-Driven Forms places most of the form handling logic within that form's
template
Reactive Forms places form handling logic within a component's class properties and
provides interaction through observables
242
Getting Started
Getting Started
Opt-In APIs
Before we dive into any of the form features, we need to do a little bit of housekeeping. We
need to bootstrap our application using the FormsModule or ReactiveFormsModule .
@NgModule({
imports: [
BrowserModule,
FormsModule,
],
declarations: [AppComponent],
bootstrap: [AppComponent]
})
export class AppModule {
}
platformBrowserDynamic().bootstrapModule(AppModule)
Input Labeling
Most of the form examples use the following HTML5 style for labeling inputs:
<label for="name">Name</label>
<input type="text" name="username" id="name">
Angular also supports the alternate HTML5 style, which precludes the necessity of id s on
<input> s:
<label>
Name
<input type="text" name="username">
</label>
243
Template-Driven Forms
Template-Driven Forms
The most straightforward approach to building forms in Angular is to take advantage of the
directives provided for you.
<label for="password">Password</label>
<input type="password" name="password" id="password">
Angular has already provided you a form directive, and form related directives such as
input, etc which operates under the covers. For a basic implementation, we just have to add
a few attributes and make sure our component knows what to do with the data.
index.html
<signup-form>Loading...</signup-form>
signup-form.component.html
<label for="password">Password</label>
<input type="password" name="password" id="password" ngModel>
signup-form.component.ts
244
Template-Driven Forms
@Component({
selector: 'app-signup-form',
templateUrl: 'app/signup-form.component.html',
})
export class SignupFormComponent {
registerUser(form: NgForm) {
console.log(form.value);
// {email: '...', password: '...'}
// ...
}
}
245
Nesting Form Data
Let's assume you had a payment endpoint which required data, similar to the following:
{
"contact": {
"firstname": "Bob",
"lastname": "McKenzie",
"email": "[email protected]",
"phone": "555-TAKE-OFF"
},
"address": {
"street": "123 Some St",
"city": "Toronto",
"region": "ON",
"country": "CA",
"code": "H0H 0H0"
},
"paymentCard": {
"provider": "Credit Lending Company Inc",
"cardholder": "Doug McKenzie",
"number": "123 456 789 012",
"verification": "321",
"expiry": "2020-02"
}
}
While forms are flat and one-dimensional, the data built from them is not. This leads to
complex transforms to convert the data youve been given into the shape you need.
Worse, in cases where it is possible to run into naming collisions in form inputs, you might
find yourself using long and awkward names for semantic purposes.
246
Nesting Form Data
<form>
<fieldset>
<legend>Contact</legend>
<label for="contact_email">Email</label>
<input type="email" name="contact_email" id="contact_email">
<label for="contact_phone">Phone</label>
<input type="text" name="contact_phone" id="contact_phone">
</fieldset>
</form>
A form handler would have to convert that data into a form that your API expects. Thankfully,
this is something Angular has a solution for.
ngModelGroup
When building a template-driven form in Angular, we can lean on the ngModelGroup directive
to arrive at a cleaner implementation, while Angular does the heavy lifting of converting
form-fields into nested data.
247
Nesting Form Data
<label>
First Name <input type="text" name="firstname" ngModel>
</label>
<label>
Last Name <input type="text" name="lastname" ngModel>
</label>
<label>
Email <input type="email" name="email" ngModel>
</label>
<label>
Phone <input type="text" name="phone" ngModel>
</label>
</fieldset>
<fieldset ngModelGroup="address">
<!-- ... -->
</fieldset>
<fieldset ngModelGroup="paymentCard">
<!-- ... -->
</fieldset>
</form>
Using the alternative HTML5 labeling format; IDs have no bearing on the ngForm /
ngModel paradigm
If we were to fill out the form, it would end up in the shape we need for our API, and we can
still rely on the HTML field validation if we know its available.
248
Using Template Model Binding
app/signup-form.component.html
<label for="email">Email</label>
<input type="email" name="email" id="email" ngModel>
app/signup-form.component.ts
@Component({
// ...
})
export class SignupFormComponent {
generatedUser: string = generateUniqueUserID();
register(form: NgForm) {
console.log(form.value);
// ...
}
}
Two-Way Binding
While Angular assumes one-way binding by default, two-way binding is still available if you
need it.
In order to have access to two-way binding in template-driven forms, use the Banana-Box
syntax ( [(ngModel)]="propertyName" ).
249
Using Template Model Binding
Be sure to declare all of the properties you will need on the component.
<label for="email">Email</label>
<input type="email" name="email" id="email" [(ngModel)]="email">
@Component({
// ...
})
export class SignUpFormComponent {
username: string = generateUniqueUserID();
email = '';
register(form: NgForm) {
console.log(form.value.username);
console.log(this.username);
// ...
}
}
250
Validating Template-Driven Forms
Note that the pattern attribute is a less-powerful version of JavaScript's RegEx syntax.
There are other HTML5 attributes which can be learned and applied to various types of
input; however in most cases they act as upper and lower limits, preventing extra information
from being added or removed.
You can use one or both of these methods when writing a template-driven form. Focus on
the user experience: in some cases, it makes sense to prevent accidental entry, and in
others it makes sense to allow unrestricted entry but provide something like a counter to
show limitations.
251
Reactive/Model-Driven Forms
Reactive/Model-Driven Forms
While using directives in our templates gives us the power of rapid prototyping without too
much boilerplate, we are restricted in what we can do. Reactive forms on the other hand,
lets us define our form through code and gives us much more flexibility and control over data
validation.
There is a little bit of magic in its simplicity at first, but after you're comfortable with the
basics, learning its building blocks will allow you to handle more complex use cases.
252
FormBuilder Basics
This will give us access to components, directives and providers like FormBuilder ,
FormGroup , and FormControl
In our case, to build a login form, we're looking at something like the following:
app/login-form.component.ts
@Component({
selector: 'app-root',
templateUrl: 'app/app.component.html'
})
export class AppComponent {
username = new FormControl('')
password = new FormControl('')
login() {
console.log(this.loginForm.value);
// Attempt Logging in...
}
}
app/login-form.component.html
253
FormBuilder Basics
<label for="password">password</label>
<input type="password" name="password" id="password" [formControl]="password">
<br>
View Example
FormControl
Note that the FormControl class is assigned to similarly named fields, both on this and in
the FormBuilder#group({ }) method. This is mostly for ease of access. By saving references
to the FormControl instances on this , you can access the inputs in the template without
having to reference the form itself. The form fields can otherwise be reached in the template
by using loginForm.controls.username and loginForm.controls.password . Likewise, any
instance of FormControl in this situation can access its parent group by using its .root
property (e.g. username.root.controls.password ).
Make sure that root and controls exist before they're used.
A FormControl requires two properties: an initial value and a list of validators. Right now, we
have no validation. This will be added in the next steps.
254
Validating FormBuilder Forms
Angular provides many validators out of the box. They can be imported along with the rest of
dependencies for procedural forms.
app/login-form.component.ts
@Component({
// ...
})
export class AppComponent {
username = new FormControl('', [
Validators.required,
Validators.minLength(5)
]);
login () {
console.log(this.loginForm.value);
// Attempt Logging in...
}
}
app/login-form.component.html
255
Validating FormBuilder Forms
<div>
<label for="username">username</label>
<input
type="text"
name="username"
id="username"
[formControl]="username">
<div [hidden]="!username.hasError('minlength')">
Username can not be shorter than 5 characters.
</div>
<div [hidden]="!username.hasError('required')">
Username is required.
</div>
</div>
</div>
<div >
<label for="password">password</label>
<input
type="password"
name="password"
id="password" [formControl]="password">
<div [hidden]="!password.hasError('required')">
The password is required.
</div>
</div>
</div>
Note that we have added rather robust validation on both the fields and the form itself, using
nothing more than built-in validators and some template logic.
View Example
256
Validating FormBuilder Forms
We are using .valid and .untouched to determine if we need to show errors - while the
field is required, there is no reason to tell the user that the value is wrong if the field hasn't
been visited yet.
For built-in validation, we are calling .hasError() on the form element, and we are passing
a string which represents the validator function we included. The error message only
displays if this test returns true.
257
FormBuilder Custom Validation
Let's assume we are using the same Login Form, but now we also want to test that our
password has an exclamation mark somewhere in it.
app/login-form.component.ts
A simple function takes the FormControl instance and returns null if everything is fine. If the
test fails, it returns an object with an arbitrarily named property. The property name is what
will be used for the .hasError() test.
app/login-form.component.ts
View Example
Predefined Parameters
Having a custom validator to check for exclamation marks might be helpful, but what if you
need to check for some other form of punctuation? It might be overkill to write nearly the
same thing over and over again.
Consider the earlier example Validators.minLength(5) . How did they get away with allowing
an argument to control the length, if a validator is just a function? Simple, really. It's not a
trick of Angular, or TypeScript - it's simple JavaScript closures.
258
FormBuilder Custom Validation
function minLength(minimum) {
return function(input) {
return input.value.length >= minimum ? null : { minLength: true };
};
}
Assume you have a function which takes a "minimum" parameter and returns another
function. The function defined and returned from the inside becomes the validator. The
closure reference allows you to remember the value of the minimum when the validator is
eventually called.
app/login-form.component.ts
// ...
app/login-form.component.html
View Example
259
FormBuilder Custom Validation
// ...
View Example
260
Visual Cues for Users
input[type="text"]:valid {
border: 2px solid green;
}
input[type="text"]:invalid {
border: 2px solid red;
}
Unfortunately, this system is rather unsophisticated and would require more manual effort in
order to work with complex forms or user behavior.
Rather than writing extra code, and creating and enforcing your own CSS classes, to
manage these behaviors, Angular provides you with several classes, already accessible on
your inputs.
/* field has not been clicked in, tapped on, or tabbed over */
.ng-untouched {}
valid / invalid
untouched / touched
pristine / dirty
261
Visual Cues for Users
These pairs can be used in many combinations in your CSS to change style based on the
three separate flags they represent. Angular will toggle between the pairs on each input as
the state of the input changes.
.ng-untouched will not be replaced by .ng-touched until the user leaves the input for
For templating purposes, Angular also gives you access to the unprefixed properties on the
input, in both code and template:
262
Modules
Modules
Angular Modules provides a mechanism for creating blocks of functionality that can be
combined to build an application.
Figure: Used Lego Duplo Bricks by Arto Alanenp is licensed under CC BY-SA 4.0
(https://commons.wikimedia.org/wiki/File:Lego_dublo_arto_alanenpaa_5.JPG)
263
What is an Angular Module?
Another analogy to understand Angular modules is classes. In a class, we can define public
or private methods. The public methods are the API that other parts of our code can use to
interact with it while the private methods are implementation details that are hidden. In the
same way, a module can export or hide components, directives, pipes and services. The
exported elements are meant to be used by other modules, while the ones that are not
exported (hidden) are just used inside the module itself and cannot be directly accessed by
other modules of our application.
@NgModule({
imports: [ ... ],
declarations: [ ... ],
bootstrap: [ ... ]
})
export class AppModule { }
In the example above, we have turned the class AppModule into an Angular module just by
using the NgModule decorator. The NgModule decorator requires at least three properties:
imports , declarations and bootstrap .
The property imports expects an array of modules. Here's where we define the pieces of
our puzzle (our application). The property declarations expects an array of components,
directives and pipes that are part of the module. The bootstrap property is where we define
the root component of our module. Even though this property is also an array, 99% of the
time we are going to define only one component.
There are very special circumstances where more than one component may be
required to bootstrap a module but we are not going to cover those edge cases here.
264
What is an Angular Module?
Here's how a basic module made up of just one component would look like:
app/app.component.ts
@Component({
selector: 'app-root',
template: '<h1>My Angular App</h1>'
})
export class AppComponent {}
app/app.module.ts
@NgModule({
imports: [BrowserModule],
declarations: [AppComponent],
bootstrap: [AppComponent]
})
export class AppModule { }
The file app.component.ts is just a "hello world" component, nothing interesting there. In the
other hand, the file app.module.ts is following the structure that we've seen before for
defining a module but in this case, we are defining the modules and components that we are
going to be using.
The first thing that we notice is that our module is importing the BrowserModule as an explicit
dependency. The BrowserModule is a built-in module that exports basic directives, pipes and
services. Unlike previous versions of Angular, we have to explicitly import those
dependencies to be able to use directives like *ngFor or *ngIf in our templates.
Given that the root (and only) component of our module is the AppComponent we have to list
it in the bootstrap array. Because in the declarations property we are supposed to define
all the components or pipes that make up our application, we have to define the
AppComponent again there too.
Before moving on, there's an important clarification to make. There are two types of
modules, root modules and feature modules.
265
What is an Angular Module?
In the same way that in a module we have one root component and many possible
secondary components, in an application we only have one root module and zero or
many feature modules. To be able to bootstrap our application, Angular needs to know
which one is the root module. An easy way to identify a root module is by looking at the
imports property of its NgModule decorator. If the module is importing the BrowserModule
then it's a root module, if instead is importing the CommonModule then it is a feature module.
As developers, we need to take care of importing the BrowserModule in the root module
and instead, import the CommonModule in any other module we create for the same
application. Failing to do so might result in problems when working with lazy loaded
modules as we are going to see in following sections.
Bootstrapping an Application
To bootstrap our module based application, we need to inform Angular which one is our root
module to perform the compilation in the browser. This compilation in the browser is also
known as "Just in Time" (JIT) compilation.
main.ts
platformBrowserDynamic().bootstrapModule(AppModule);
It is also possible to perform the compilation as a build step of our workflow. This
method is called "Ahead of Time" (AOT) compilation and will require a slightly different
bootstrap process that we are going to discuss in another section.
View Example
In the next section we are going to see how to create a module with multiple components,
services and pipes.
266
Adding Components, Pipes and Services to a Module
Let's start by defining a new component that we are going to use to show credit card
information.
credit-card.component.ts
@Component({
selector: 'app-credit-card',
template: `
<p>Your credit card is: {{ creditCardNumber | creditCardMask }}</p>
`
})
export class CreditCardComponent implements OnInit {
creditCardNumber: string;
ngOnInit() {
this.creditCardNumber = this.creditCardService.getCreditCard();
}
}
This component is relying on the CreditCardService to get the credit card number, and on
the pipe creditCardMask to mask the number except the last 4 digits that are going to be
visible.
credit-card.service.ts
267
Adding Components, Pipes and Services to a Module
@Injectable()
export class CreditCardService {
getCreditCard(): string {
return '2131313133123174098';
}
}
credit-card-mask.pipe.ts
@Pipe({
name: 'creditCardMask'
})
export class CreditCardMaskPipe implements PipeTransform {
transform(plainCreditCard: string): string {
const visibleDigits = 4;
let maskedSection = plainCreditCard.slice(0, -visibleDigits);
let visibleSection = plainCreditCard.slice(-visibleDigits);
return maskedSection.replace(/./g, '*') + visibleSection;
}
}
With everything in place, we can now use the CreditCardComponent in our root component.
app.component.ts
@Component({
selector: 'app-root',
template: `
<h1>My Angular App</h1>
<app-credit-card></app-credit-card>
`
})
export class AppComponent {}
Of course, to be able to use this new component, pipe and service, we need to update our
module, otherwise Angular is not going to be able to compile our application.
app.module.ts
268
Adding Components, Pipes and Services to a Module
@NgModule({
imports: [BrowserModule],
providers: [CreditCardService],
declarations: [
AppComponent,
CreditCardMaskPipe,
CreditCardComponent
],
bootstrap: [AppComponent]
})
export class AppModule { }
Notice that we have added the component CreditCardComponent and the pipe
CreditCardMaskPipe to the declarations property, along with the root component of the
module AppComponent . In the other hand, our custom service is configured with the
dependency injection system with the providers property.
View Example
Be aware that this method of defining a service in the providers property should only be
used in the root module. Doing this in a feature module is going to cause unintended
consequences when working with lazy loaded modules.
In the next section, we are going to see how to safely define services in feature modules.
269
Creating a Feature Module
In our previous example, we started to see that. Our root module has a component, a pipe
and a service that its only purpose is to deal with credit cards. What if we extract these three
elements to their own feature module and then we import it into our root module?
We are going to do just that. The first step is to create two folders to differentiate the
elements that belong to the root module from the elements that belong to the feature
module.
.
app
app.component.ts
app.module.ts
credit-card
credit-card-mask.pipe.ts
credit-card.component.ts
credit-card.module.ts
credit-card.service.ts
index.html
main.ts
Notice how each folder has its own module file: app.module.ts and credit-card.module.ts.
Let's focus on the latter first.
credit-card/credit-card.module.ts
270
Creating a Feature Module
@NgModule({
imports: [CommonModule],
declarations: [
CreditCardMaskPipe,
CreditCardComponent
],
providers: [CreditCardService],
exports: [CreditCardComponent]
})
export class CreditCardModule {}
Our feature CreditCardModule it's pretty similar to the root AppModule with a few important
differences:
We are not importing the BrowserModule but the CommonModule . If we see the
documentation of the BrowserModule here, we can see that it's re-exporting the
CommonModule with a lot of other services that helps with rendering an Angular
application in the browser. These services are coupling our root module with a particular
platform (the browser), but we want our feature modules to be platform independent.
That's why we only import the CommonModule there, which only exports common
directives and pipes.
When it comes to components, pipes and directives, every module should import its
own dependencies disregarding if the same dependencies were imported in the root
module or in any other feature module. In short, even when having multiple feature
modules, each one of them needs to import the CommonModule .
We are using a new property called exports . Every element defined in the
declarations array is private by default. We should only export whatever the other
modules in our application need to perform its job. In our case, we only need to make
the CreditCardComponent visible because it's being used in the template of the
AppComponent .
app/app.component.ts
271
Creating a Feature Module
...
@Component({
...
template: `
...
<app-credit-card></app-credit-card>
`
})
export class AppComponent {}
We are keeping the CreditCardMaskPipe private because it's only being used inside the
CreditCardModule and no other module should use it directly.
We can now import this feature module into our simplified root module.
app/app.module.ts
@NgModule({
imports: [
BrowserModule,
CreditCardModule
],
declarations: [AppComponent],
bootstrap: [AppComponent]
})
export class AppModule { }
View Example
It's hard to understand that at first so let's try to see what's happening with the
CreditCardService in our example. Notice first that the service is not in the exports array
but in the providers array. With this configuration, our service is going to be available
272
Creating a Feature Module
everywhere, even in the AppComponent which lives in another module. So, even when using
modules, there's no way to have a "private" service unless... the module is being lazy
loaded.
When a module is lazy loaded, Angular is going to create a child injector (which is a child of
the root injector from the root module) and will create an instance of our service there.
Imagine for a moment that our CreditCardModule is configured to be lazy loaded. With our
current configuration, when the application is bootstrapped and our root module is loaded in
memory, an instance of the CreditCardService (a singleton) is going to be added to the root
injector. But, when the CreditCardModule is lazy loaded sometime in the future, a child
injector will be created for that module with a new instance of the CreditCardService . At
this point we have a hierarchical injector with two instances of the same service, which is
not usually what we want.
Think for example of a service that does the authentication. We want to have only one
singleton in the entire application, disregarding if our modules are being loaded at bootstrap
or lazy loaded. So, in order to have our feature module's service only added to the root
injector, we need to use a different approach.
credit-card/credit-card.module.ts
@NgModule({
imports: [CommonModule],
declarations: [
CreditCardMaskPipe,
CreditCardComponent
],
exports: [CreditCardComponent]
})
export class CreditCardModule {
static forRoot(): ModuleWithProviders {
return {
ngModule: CreditCardModule,
providers: [CreditCardService]
}
}
}
Different than before, we are not putting our service directly in the property providers of the
NgModule decorator. This time we are defining a static method called forRoot where we
273
Creating a Feature Module
app/app.module.ts
/* ...imports... */
@NgModule({
imports: [
BrowserModule,
CreditCardModule.forRoot()
],
declarations: [AppComponent],
bootstrap: [AppComponent]
})
export class AppModule { }
Can you spot the difference? We are not importing the CreditCardModule directly, instead
what we are importing is the object returned from the forRoot method, which includes the
CreditCardService . Although this syntax is a little more convoluted than the original, it will
guarantee us that only one instance of the CreditCardService is added to the root module.
When the CreditCardModule is loaded (even lazy loaded), no new instance of that service is
going to be added to the child injector.
View Example
As a rule of thumb, always use the forRoot syntax when exporting services from
feature modules, unless you have a very special need that requires multiple instances at
different levels of the dependency injection tree.
274
Directive Duplications
Directive Duplications
Because we no longer define every component and directive directly in every component
that needs it, we need to be aware of how Angular modules handle directives and
components that target the same element (have the same selector).
Let's assume for a moment that by mistake, we have created two directives that target the
same property:
blue-highlight.directive.ts
@Directive({
selector: '[appHighlight]'
})
export class BlueHighlightDirective {
constructor(renderer: Renderer, el: ElementRef) {
renderer.setElementStyle(el.nativeElement, 'backgroundColor', 'blue');
renderer.setElementStyle(el.nativeElement, 'color', 'gray');
}
}
yellow-highlight.directive.ts
@Directive({
selector: '[appHighlight]'
})
export class YellowHighlightDirective {
constructor(renderer: Renderer, el: ElementRef) {
renderer.setElementStyle(el.nativeElement, 'backgroundColor', 'yellow');
}
}
These two directives are similar, they are trying to style an element. The
BlueHighlightDirective will try to set the background color of the element to blue while
changing the color of the text to gray, while the YellowHighlightDirective will try only to
change the background color to yellow. Notice that both are targeting any HTML element
that has the property appHighlight . What would happen if we add both directives to the
same module?
275
Directive Duplications
app.module.ts
// Imports
@NgModule({
imports: [BrowserModule],
declarations: [
AppComponent,
BlueHighlightDirective,
YellowHighlightDirective
],
bootstrap: [AppComponent]
})
export class AppModule { }
Let's see how we would use it in the only component of the module.
app.component.ts
@Component({
selector: 'app-root',
template: '<h1 appHighlight>My Angular App</h1>'
})
export class AppComponent {}
We can see that in the template of our component, we are using the directive appHighlight
in our h1 element but, which styles are going to end up being applied?
The answer is: the text is going to be gray and the background yellow.
View Example
We are allowed to define multiple directives that target the same elements in the same
module. What's going to happen is that Angular is going to do every transformation in order.
declarations: [
...,
BlueHighlightDirective,
YellowHighlightDirective
]
Because we have defined both directives in an array, and arrays are ordered collection of
items, when the compiler finds an element with the property appHighlight , it will first apply
the transformations of BlueHighlightDirective , setting the text gray and the background
276
Directive Duplications
blue, and then will apply the transformations of YellowHighlightDirective , changing again
the background color to yellow.
In summary, when two or more directives target the same element, they are going to
be applied in the order they were defined.
277
Lazy Loading a Module
To show this relationship, let's start by defining a simple module that will act as the root
module of our example application.
app/app.module.ts
@NgModule({
imports: [
BrowserModule,
routing
],
declarations: [
AppComponent,
EagerComponent
],
bootstrap: [AppComponent]
})
export class AppModule {}
So far this is a very common module that relies on the BrowserModule , has a routing
mechanism and two components: AppComponent and EagerComponent . For now, let's focus
on the root component of our application ( AppComponent ) where the navigation is defined.
app/app.component.ts
278
Lazy Loading a Module
@Component({
selector: 'app-root',
template: `
<h1>My App</h1>
<nav>
<a routerLink="eager">Eager</a>
<a routerLink="lazy">Lazy</a>
</nav>
<router-outlet></router-outlet>
`
})
export class AppComponent {}
Our navigation system has only two paths: eager and lazy . To know what those paths are
loading when clicking on them we need to take a look at the routing object that we passed
to the root module.
app/app.routing.ts
Here we can see that the default path in our application is called eager which will load
EagerComponent .
app/eager.component.ts
@Component({
template: '<p>Eager Component</p>'
})
export class EagerComponent {}
279
Lazy Loading a Module
But more importantly, we can see that whenever we try to go to the path lazy , we are
going to lazy load a module conveniently called LazyModule . Look closely at the definition of
that route:
There's nothing special about LazyModule other than it has its own routing and a
component called LazyComponent .
app/lazy/lazy.module.ts
@NgModule({
imports: [routing],
declarations: [LazyComponent]
})
export class LazyModule {}
If we define the class LazyModule as the default export of the file, we don't need to
define the class name in the loadChildren property as shown above.
The routing object is very simple and only defines the default component to load when
navigating to the lazy path.
app/lazy/lazy.routing.ts
280
Lazy Loading a Module
Notice that we use the method call forChild instead of forRoot to create the routing
object. We should always do that when creating a routing object for a feature module, no
matter if the module is supposed to be eagerly or lazily loaded.
Finally, our LazyComponent is very similar to EagerComponent and is just a placeholder for
some text.
app/lazy/lazy.component.ts
@Component({
template: '<p>Lazy Component</p>'
})
export class LazyComponent {}
View Example
When we load our application for the first time, the AppModule along the AppComponent will
be loaded in the browser and we should see the navigation system and the text "Eager
Component". Until this point, the LazyModule has not being downloaded, only when we click
the link "Lazy" the needed code will be downloaded and we will see the message "Lazy
Component" in the browser.
281
Lazy Loading and the Dependency Injection Tree
To show this behaviour, let's continue with the example of the previous section and add a
CounterService to our LazyModule .
app/lazy/lazy.module.ts
...
import { CounterService } from './counter.service';
@NgModule({
...
providers: [CounterService]
})
export class LazyModule {}
app/lazy/counter.service.ts
@Injectable()
export class CounterService {
counter = 0;
}
We can modify the LazyComponent to use this service with a button to increment the
counter property.
app/lazy/lazy.component.ts
282
Lazy Loading and the Dependency Injection Tree
@Component({
template: `
<p>Lazy Component</p>
<button (click)="increaseCounter()">Increase Counter</button>
<p>Counter: {{ counterService.counter }}</p>
`
})
export class LazyComponent {
increaseCounter() {
this.counterService.counter += 1;
}
}
View Example
The service is working. If we increment the counter and then navigate back and forth
between the eager and the lazy routes, the counter value will persist in the lazy loaded
module.
But the question is, how can we verify that the service is isolated and cannot be used in a
component that belongs to a different module? Let's try to use the same service in the
EagerComponent .
app/eager.component.ts
@Component({
template: `
<p>Eager Component</p>
<button (click)="increaseCounter()">Increase Counter</button>
<p>Counter: {{ counterService.counter }}</p>
`
})
export class EagerComponent {
constructor(public counterService: CounterService) {}
increaseCounter() {
this.counterService.counter += 1;
}
}
283
Lazy Loading and the Dependency Injection Tree
If we try to run this new version of our code, we are going to get an error message in the
browser console:
What this error tells us is that the AppModule , where the EagerComponent is defined, has no
knowledge of a service called CounterService . CounterService lives in a different branch of
the DI tree created for LazyModule when it was lazy loaded in the browser.
284
Shared Modules and Dependency Injection
Let's create a new module called SharedModule and define the CounterService there.
app/shared/shared.module.ts
@NgModule({
providers: [CounterService]
})
export class SharedModule {}
Now we are going to import that SharedModule in the AppModule and the LazyModule .
app/app.module.ts
...
import { SharedModule } from './shared/shared.module';
@NgModule({
imports: [
SharedModule,
...
],
declarations: [
EagerComponent,
...
]
...
})
export class AppModule {}
app/lazy/lazy.module.ts
285
Shared Modules and Dependency Injection
...
import { SharedModule } from '../shared/shared.module';
@NgModule({
imports: [
SharedModule,
...
],
declarations: [LazyComponent]
})
export class LazyModule {}
With this configuration, the components of both modules will have access to the
CounterService . We are going to use this service in EagerComponent and LazyComponent in
exactly the same way. Just a button to increase the internal counter property of the service.
app/eager.component.ts
@Component({
template: `
<p>Eager Component</p>
<button (click)="increaseCounter()">Increase Counter</button>
<p>Counter: {{ counterService.counter }}</p>
`
})
export class EagerComponent {
constructor(public counterService: CounterService) {}
increaseCounter() {
this.counterService.counter += 1;
}
}
View Example
If you play with the live example, you will notice that the counter seems to behave
independently in EagerComponent and LazyComponent , we can increase the value of one
counter without altering the other one. In other words, we have ended up with two instances
of the CounterService , one that lives in the root of the DI tree of the AppModule and another
that lives in a lower branch of the DI tree accessible by the LazyModule .
This is not neccessarily wrong, you may find situations where you could need different
instances of the same service, but I bet most of the time that's not what you want. Think for
example of an authentication service, you need to have the same instance with the same
286
Shared Modules and Dependency Injection
In the next section we are going to learn how to have only one instance of a shared service.
287
Sharing the Same Dependency Injection Tree
To accomplish that, we need to modify the definition of the SharedModule and instead of
defining our service in the providers property, we need to create a static method called
forRoot that exports the service along with the module itself.
app/shared/shared.module.ts
@NgModule({})
export class SharedModule {
static forRoot(): ModuleWithProviders {
return {
ngModule: SharedModule,
providers: [CounterService]
};
}
}
With this setup, we can import this module in our root module AppModule calling the
forRoot method to register the module and the service.
app/app.module.ts
...
import { SharedModule } from './shared/shared.module';
@NgModule({
imports: [
SharedModule.forRoot(),
...
],
...
})
export class AppModule {}
288
Sharing the Same Dependency Injection Tree
We should only call forRoot in the root application module and no where else. This
ensures that only a single instance of your service exists at the root level. Calling forRoot
in another module can register the service again in a different level of the DI tree.
Since SharedModule only consists of a service that Angular registers in the root app injector,
we do not need to import it in LazyModule . This is because the lazy loaded module will
already have access to services defined at the root level.
View Example
This time, whenever we change the value of the counter property, this value is shared
between the EagerComponent and the LazyComponent proving that we are using the same
instance of the CounterService .
However it is very likely that we may have a component, pipe or directive defined in
SharedModule that we'll need in another module. Take the following for example.
app/shared/shared.module.ts
@NgModule({
declarations: [HighlightDirective],
exports: [ HighlightDirective ]
})
export class SharedModule {
static forRoot(): ModuleWithProviders {
return {
ngModule: SharedModule,
providers: [CounterService]
};
}
}
LazyModule normally.
app/lazy/lazy.module.ts
289
Sharing the Same Dependency Injection Tree
@NgModule({
imports: [
SharedModule,
routing
],
declarations: [LazyComponent]
})
export class LazyModule {}
Now we can use this directive within LazyModule without creating another instance of
CounterService .
View Example
290
Routing
Routing
In this section we will discuss the role of routing in Single Page Applications and Angular's
new component router.
291
Why Routing?
Why Routing?
Routing allows us to express some aspects of the application's state in the URL. Unlike with
server-side front-end solutions, this is optional - we can build the full application without ever
changing the URL. Adding routing, however, allows the user to go straight into certain
aspects of the application. This is very convenient as it can keep your application linkable
and bookmarkable and allow users to share links with others.
292
Configuring Routes
Configuring Routes
<base href="/">
In the demos we use a script tag to set the base tag. In a real application it must be set
as above.
Each route can have different attributes; some of the common attributes are:
path - URL to be shown in the browser when application is on the specific route
component - component to be rendered when the application is on the specific route
redirectTo - redirect route if needed; each route can have either component or redirect
attribute defined in the route (covered later in this chapter)
pathMatch - optional property that defaults to 'prefix'; determines whether to match full
URLs or just the beginning. When defining a route with empty path string set pathMatch
to 'full', otherwise it will match all paths.
children - array of route definitions objects representing the child routes of this route
(covered later in this chapter).
293
Configuring Routes
RouterModule
RouterModule.forRoot takes the Routes array as an argument and returns a configured
router module. The following sample shows how we import this module in an app.routes.ts
file.
app/app.routes.ts
...
import { RouterModule, Routes } from '@angular/router';
app/app.module.ts
...
import { routing } from './app.routes';
@NgModule({
imports: [
BrowserModule,
routing
],
declarations: [
AppComponent,
ComponentOne,
ComponentTwo
],
bootstrap: [ AppComponent ]
})
export class AppModule {
}
294
Redirecting the Router to Another Route
The pathMatch property, which is required for redirects, tells the router how it should match
the URL provided in order to redirect to the specified route. Since pathMatch: full is
provided, the router will redirect to component-one if the entire URL matches the empty path
('').
When starting the application, it will now automatically navigate to the route for component-
one .
295
Defining Links Between Routes
RouterLink
Add links to routes using the RouterLink directive.
For example the following code defines a link to the route at path component-one .
Navigating Programmatically
Alternatively, you can navigate to a route by calling the navigate function on the router:
this.router.navigate(['/component-one']);
296
Dynamically Adding Route Components
@Component({
selector: 'app',
template: `
<nav>
<a routerLink="/component-one">Component One</a>
<a routerLink="/component-two">Component Two</a>
</nav>
<router-outlet></router-outlet>
<!-- Route components are added by router here -->
`
})
export class AppComponent {}
In the above example, the component corresponding to the route specified will be placed
after the <router-outlet></router-outlet> element when the link is clicked.
View Example
View examples running in full screen mode to see route changes in the URL.
297
Using Route Parameters
Note :id in the path of the product-details route, which places the parameter in the path.
For example, to see the product details page for product with ID 5, you must use the
following URL: localhost:3000/product-details/5
Note that the routerLink directive passes an array which specifies the path and the route
parameter. Alternatively we could navigate to the route programmatically:
298
Using Route Parameters
goToProductDetails(id) {
this.router.navigate(['/product-details', id]);
}
@Component({
selector: 'product-details',
template: `
<div>
Showing product details for product: {{id}}
</div>
`,
})
export class LoanDetailsPage implements OnInit, OnDestroy {
id: number;
private sub: any;
ngOnInit() {
this.sub = this.route.params.subscribe(params => {
this.id = +params['id']; // (+) converts string 'id' to a number
ngOnDestroy() {
this.sub.unsubscribe();
}
}
The reason that the params property on ActivatedRoute is an Observable is that the
router may not recreate the component when navigating to the same component. In this
case the parameter may change without the component being recreated.
299
Using Route Parameters
View examples running in full screen mode to see route changes in the URL.
300
Defining Child Routes
For example: The product details page may have a tabbed navigation section that shows the
product overview by default. When the user clicks the "Technical Specs" tab the section
shows the specs instead.
If the user clicks on the product with ID 3, we want to show the product details page with the
overview:
localhost:3000/product-details/3/overview
overview and specs are child routes of product-details/:id . They are only reachable
Where would the components for these child routes be displayed? Just like we had a
<router-outlet></router-outlet> for the root application component, we would have a
router outlet inside the ProductDetails component. The components corresponding to the
child routes of product-details would be placed in the router outlet in ProductDetails .
301
Defining Child Routes
@Component({
selector: 'product-details',
template: `
<p>Product Details: {{id}}</p>
<!-- Product information -->
<nav>
<a [routerLink]="['overview']">Overview</a>
<a [routerLink]="['specs']">Technical Specs</a>
</nav>
<router-outlet></router-outlet>
<!-- Overview & Specs components get added here by the router -->
`
})
export default class ProductDetails implements OnInit, OnDestroy {
id: number;
ngOnInit() {
this.sub = this.route.params.subscribe(params => {
this.id = +params['id']; // (+) converts string 'id' to a number
});
}
ngOnDestroy() {
this.sub.unsubscribe();
}
}
Since the Overview child route of product-details has an empty path, it will be loaded by
default. The specs child route remains the same.
302
Defining Child Routes
View examples running in full screen mode to see route changes in the URL.
ngOnInit() {
// Get parent ActivatedRoute of this route.
this.sub = this.router.routerState.parent(this.route)
.params.subscribe(params => {
this.parentRouteId = +params["id"];
});
}
ngOnDestroy() {
this.sub.unsubscribe();
}
}
View examples running in full screen mode to see route changes in the URL.
Links
Routes can be prepended with / , or ../ ; this tells Angular where in the route tree to link
to.
303
Defining Child Routes
Prefix Looks in
/ Root of the application
none Current component children routes
../ Current component parent routes
Example:
In the above example, the link for route one links to a child of the current route. The link for
route two links to a sibling of the current route. The link for route three links to a child of the
root component (same as route one link if current route is root component).
View examples running in full screen mode to see route changes in the URL.
304
Controlling Access to or from a Route
For example, we may want some routes to only be accessible once the user has logged in
or accepted Terms & Conditions. We can use route guards to check these conditions and
control access to routes.
Route guards can also control whether a user can leave a certain route. For example, say
the user has typed information into a form on the page, but has not submitted the form. If
they were to leave the page, they would lose the information. We may want to prompt the
user if the user attempts to leave the route without submitting or saving the information.
For example, say we have an accounts route that only users that are logged in can
navigate to. This page also has forms and we want to make sure the user has submitted
unsaved changes before leaving the accounts page.
305
Controlling Access to or from a Route
Now LoginRouteGuard will be checked by the router when activating the accounts route,
and SaveFormsGuard will be checked when leaving that route.
Implementing CanActivate
Let's look at an example activate guard that checks whether the user is logged in:
@Injectable()
export class LoginRouteGuard implements CanActivate {
canActivate() {
return this.loginService.isLoggedIn();
}
}
When canActivate returns true, the user can activate the route. When canActivate returns
false, the user cannot access the route. In the above example, we allow access when the
user is logged in.
canActivate can also be used to notify the user that they can't access that part of the
Implementing CanDeactivate
CanDeactivate works in a similar way to CanActivate but there are some important
306
Controlling Access to or from a Route
We can use that component to determine whether the user can deactivate.
@Injectable()
export class SaveFormsGuard implements CanDeactivate<AccountPage> {
canDeactivate(component: AccountPage) {
return component.areFormsSaved();
}
asynchronous request (like a server request) to determine whether the user can navigate to
or away from the route, you can simply return an Observable<boolean> . The router will wait
until it is resolved and use that value to determine access.
For example, when the user navigates away you could have a dialog service ask the user to
confirm the navigation. The dialog service returns an Observable<boolean> which resolves to
true if the user clicks 'OK', or false if user clicks 'Cancel'.
canDeactivate() {
return dialogService.confirm('Discard unsaved changes?');
}
View Example
307
Passing Optional Parameters to a Route
For example, on a route with a paginated list, the URL might look like the following to
indicate that we've loaded the second page:
localhost:3000/product-list?page=2
The key difference between query parameters and route parameters is that route
parameters are essential to determining route, whereas query parameters are optional.
goToPage(pageNum) {
this.router.navigate(['/product-list'], { queryParams: { page: pageNum } });
}
308
Passing Optional Parameters to a Route
@Component({
selector: 'product-list',
template: `<!-- Show product list -->`
})
export default class ProductList {
constructor(
private route: ActivatedRoute,
private router: Router) {}
ngOnInit() {
this.sub = this.route
.queryParams
.subscribe(params => {
// Defaults to 0 if no query param provided.
this.page = +params['page'] || 0;
});
}
ngOnDestroy() {
this.sub.unsubscribe();
}
nextPage() {
this.router.navigate(['product-list'], { queryParams: { page: this.page + 1 } });
}
}
View Example
309
Using Auxiliary Routes
To define the auxiliary route we must first add a named router outlet where contents for the
auxiliary route are to be rendered.
Here's an example:
@Component({
selector: 'app',
template: `
<nav>
<a [routerLink]="['/component-one']">Component One</a>
<a [routerLink]="['/component-two']">Component Two</a>
<a [routerLink]="[{ outlets: { 'sidebar': ['component-aux'] } }]">Component Aux<
/a>
</nav>
Next we must define the link to the auxiliary route for the application to navigate and render
the contents.
310
Using Auxiliary Routes
View Example
311
State Management
State Management
For larger Angular applications with a lot of asynchronous activity and where there's a lot of
state that is being shared and manipulated across multiple components and modules,
managing state can be quite challenging. In a typical application, we're managing things like:
Data that comes from the server and whether it's pending or resulted in an error
UI state like toggles, alerts and errors messages
User input, such as form submissions, filters and search queries
Custom themes, credentials and localization
Many other types of state
As the application grows, how do we know that a state change in one module will
consistently and accurately reflected in other modules? And what if these modifications
result in even more state changes? Eventually, it becomes extremely difficult to reason
about what's actually happening in your application, and be a large source of bugs.
312
Redux and @ngrx
What is Redux?
Redux is an application state manager for JavaScript applications, and keeps with the core
principles of the Flux-architecture by having a unidirectional data flow in your application.
Where Flux applications traditionally have multiple stores, Redux applications have only one
global, read-only application state. This state is calculated by "reducing" over a collection or
stream of actions that update it in controlled ways.
What is @ngrx?
Redux state managers have been very well received and have inspired the creation of
@ngrx, a set of modules that implement the same way of managing state as well as some of
the middleware and tools in the Redux ecosystem. @ngrx was created to be used
specifically with Angular and RxJS, as it leans heavily on the observable paradigm.
For further on Redux and @ngrx see the Further reading section
313
Adding @ngrx to your Project
If you plan on using the @ngrx/effects extensions to add side-effect capabilities, then also
run the following command:
314
Defining your Main Application State
To define your application state, use an interface called AppState or IAppState , depending
on the naming conventions used on your project.
Here's an example:
app/models/appState.ts
Note: We're using readonly to ensure compile-time immutability, and it provides the
simplest immutable implementation without adding more dependencies to clutter the
examples. However, feel free to use another approach on your project that makes
sense for your team.
315
Example Application
Example Application
In this chapter, you'll be creating a simple counter application using @ngrx. Your app will
allow users to increment and decrement a number by one, as well as reset that value back
to zero. Here's the AppState that we'll be using throughout the example:
app/models/appState.ts
app/models/counter.ts
It's good practice to declare each interface in its own file, and create a logical directory
structure if you have seven or more interfaces used by your application.
316
Reading your Application State using Selectors
For example, here's how you would select the counter object:
And to fetch the counter's currentValue , we can pass in a string array, where each string
plucks a single property from the application state one at a time in the order specified:
While select() allows for several variations of strings to be passed in, it has it's
shortcomings - namely you won't actually know if the plucking is working properly until you
execute your code.
Because of that, select() allows you to select values using functions too, which makes
things more type-safe and your selectors will be more refactorable by your IDE.
app/services/counter.service.ts
317
Reading your Application State using Selectors
@Injectable()
export class CounterService {
getCurrentValue(): Observable<number> {
return this.store.select(appState => appState.counter.currentValue)
.filter(Boolean);
}
the code and templates in your components, since they don't have to repeatedly consider
the falsy case everywhere the value is used.
318
Actions
Actions
Redux uses a concept called Actions, which describe state changes to your application.
Redux actions are simple JSON objects that implement the Action interface provided by
@ngrx:
The type property is a string used to uniquely identify your action to your application. It's a
common convention to use lisp-case (such as MY_ACTION ), however you are free to use
whatever casing style that makes to your team, as long as it's consistent across the project.
The payload property provides a way to pass additional data to other parts of Redux, and
it's entirely optional.
Here is an example:
Plain objects are used so that the actions are serializable and can be replayable into
the application state. Even if your actions involve asynchronous logic, the final
dispatched action will remain a plain JSON object.
To simplify action creation, you can create a factory function to take care of the repeating
parts within your application:
app/store/createAction.ts
319
Actions
The resulting creation of the LOGIN_SEND action becomes much more succinct and cleaner:
320
Modifying your Application State by Dispatching Actions
Synchronous Actions
Here is a simple example:
app/store/counter/counter.actions.ts
321
Modifying your Application State by Dispatching Actions
@Injectable()
export class CounterActions {
increment() {
this.store.dispatch(createAction(CounterActions.INCREMENT));
}
decrement() {
this.store.dispatch(createAction(CounterActions.DECREMENT));
}
reset() {
this.store.dispatch(createAction(CounterActions.RESET));
}
As you can see, the action creators are simple functions that dispatch Action objects
containing more information that describes the state modification.
Asynchronous Actions
This "ActionCreatorService" pattern comes in handy if you must handle asynchronous or
conditional actions (users of react-redux may recognize this pattern as analogous to redux-
thunk in a dependency-injected world).
app/store/counter/counter.actions.ts
322
Modifying your Application State by Dispatching Actions
@Injectable()
export class CounterActions {
incrementIfOdd() {
this.store.select(appState => appState.counter.currentValue)
.take(1)
.subscribe(currentValue => {
if (currentValue % 2 !== 0) {
this.store.dispatch(createAction(CounterActions.INCREMENT);
}
});
}
dispatching an action.
In the incrementAsync() action creator, we are delaying the actual call to dispatch() . We
created a Promise that will resolve after the delay. Once the Promise resolves, we can
then dispatch an action to increment the counter.
323
Modifying your Application State by Dispatching Actions
The ActionCreatorService pattern becomes necessary in cases where your action creators
must use other Angular services. Consider the following SessionActions service that
handles a remote API call:
@Injectable()
export class SessionActions {
constructor(
private store: Store<AppState>,
private authService: AuthService
) {
loginUser(credentials: any) {
this.store.dispatch(createAction(SessionActions.LOGIN_USER_PENDING));
this.authService.login(credentials.username, credentials.password)
.then(result => this.store.dispatch(createAction(SessionActions.LOGIN_USER_SUCCE
SS, result)))
.catch(() => this.store.dispatch(createAction(SessionActions.LOGIN_USER_ERROR)))
;
};
logoutUser() {
this.store.dispatch(createAction(SessionActions.LOGOUT_USER));
};
324
Reducers and Pure Functions
Array.reduce method, which iterates over each of the array's items and accumulates a
single value as a result. Reducers should be pure functions, meaning they don't generate
any side-effects.
325
Reducers as State Management
Reducers in a Redux application should not mutate the state, but return a copy of it, and be
side-effect free. This encourages you to think of your application as UI that gets "computed"
from a series of actions in time.
Simple Reducer
Let's take a look at a simple counter reducer.
app/store/counter/counter.reducer.ts
We can see here that we are passing in an initial state (the current number) and an Action .
To handle each action, a common approach is to use a switch statement. Instead of each
reducer needing to explicitly subscribe to the dispatcher, every action gets passed into each
reducer, which handles the actions it's interested in and then returns the new state along to
the next reducer.
Reducers should be side-effect free. This means that they should not modify things outside
of their own scope. They should simply compute the next application state as a pure function
of the reducer's arguments.
326
Reducers as State Management
For this reason, side-effect causing operations, such as updating a record in a database,
generating an id, etc. should be handled elsewhere in the application, like in your action
creators or using @ngrx/effects.
Complex Reducer
Another consideration when creating your reducers is to ensure that they are immutable and
not modifying the state of your application. If you mutate your application state, it can cause
unexpected behavior. There are a few ways to help maintain immutability in your reducers.
One way is by using new ES6 features such as Object.assign() or the spread operator for
arrays.
app/models/counter.ts
// ...
// ...
Here, the setCounterCurrentValue() function creates a new Counter object that overwrites
the counter.currentValue property with a new value while maintaining the references and
values of all of the other properties from counter .
327
Reducers as State Management
case CounterActions.DECREMENT:
return setCounterCurrentValue(counter, counter.currentValue - 1);
case CounterActions.RESET:
return setCounterCurrentValue(counter, 0);
default:
return counter;
}
}
With each action, we take the existing counter state and create a new state with the
updated value (such as counter.currentValue + 1 ).
When dealing with complex or deeply nested objects, it can be difficult to maintain
immutability in your application using this syntax. This is where a library like Ramda can
help.
328
Creating your Application's Root Reducer
app/store/rootReducer.ts
329
Configuring your Application
app/app.module.ts
import 'rxjs/Rx';
@NgModule({
imports: [
BrowserModule,
FormsModule,
HttpModule,
StoreModule.provideStore(rootReducer)
],
declarations: [
AppComponent,
CounterComponent
],
providers: [
CounterActions,
CounterService
],
bootstrap: [AppComponent]
})
export class AppModule {
330
Configuring your Application
331
Implementing Components
Implementing Components
To demonstrate how to use the CounterService in your components, let's start by building
out a small CounterComponent . The component will be responsible for incrementing and
decrementing the counter by one, as well as allowing the user to reset the counter to zero.
app/components/counter.component.ts
@Component({
selector: 'counter',
templateUrl: './counter.component.html'
})
export class CounterComponent {
constructor(
counterService: CounterService,
public actions: CounterActions
) {
this.currentValue$ = counterService.getCurrentValue();
}
app/components/counter.component.html
<p>
Clicked: {{currentValue$ | async}} times
<button (click)="actions.increment()">+</button>
<button (click)="actions.decrement()">-</button>
<button (click)="actions.reset()">Reset</button>
</p>
The template syntax should be familiar by now, displaying an Observable counter value with
the async pipe. Any time appState.counter.currentValue is updated by a reducer,
currentValue$ will receive the new value and | async will update it in the template.
332
Implementing Components
The component also handles some click events. Each click event is bound to expressions
that call our action creators from the CounterActions ActionCreatorService.
333
Component Architecture
Component Architecture
Our previous CounterComponent example is called a smart component - it knew about
Redux, the structure of the state and the actions it needed to call. In theory you can drop this
component into any area of your application and just let it work, but it will be tightly bound to
that specific slice of state and those specific actions.
For example, what if we wanted to have multiple counters tracking different things on the
page? Or how about counting the number of red clicks vs blue clicks?
To help make components more generic and reusable, it's worth trying to separate them into
container components and presentational components.
Container
Presentational Components
Components
redux docs
app/app.component.ts
334
Component Architecture
@Component({
selector: 'app-root',
templateUrl: './app.component.html',
styleUrls: ['./app.component.css']
})
export class AppComponent {
counter$: Observable<Counter>;
constructor(
counterService: CounterService,
public actions: CounterActions
) {
this.counter$ = counterService.getCounter();
}
Now our AppComponent is a smart-component, because it's aware of Redux, it's presence in
the application state and the underlying services. As with previous examples, we can use
the async pipe to obtain the most recent counter value and pass it along to other
components within the template.
And while we haven't looked at the @Output() 's on CounterComponent just yet, we'll want to
delegate those events to our action creators in CounterActions .
app/app.component.html
335
Component Architecture
In turn, we need to make the CounterComponent from a smart component into a dumb
component. For this, we will pass the data into the component using @Input properties and
click events using @Output() properties, removing the use of CounterService and
CounterActions entirely.
app/counter/counter.component.ts
@Component({
selector: 'counter',
templateUrl: './counter.component.html'
})
export class CounterComponent {
@Input()
counter: Counter;
@Output()
onIncrement: EventEmitter<void> = new EventEmitter<void>();
@Output()
onDecrement: EventEmitter<void> = new EventEmitter<void>();
@Output()
onReset: EventEmitter<void> = new EventEmitter<void>();
Our child components become much simpler and testable, because we don't have to use the
async pipe to work with our state, which removes a lot of pain when dealing with lots of
@Input 's or the need to use complex expressions with Observable 's.
We can also now simply use core Angular features to emit values whenever a click event
happens:
app/counter/counter.component.html
<p>
Clicked: {{counter.currentValue}} times
<button (click)="onIncrement.emit()">+</button>
<button (click)="onDecrement.emit()">-</button>
<button (click)="onReset.emit()">Reset</button>
</p>
336
Component Architecture
337
Side Effects
Side Effects
Often times, we need to perform some logic after an action has been dispatched and the
store has been updated. Because reducers should be side-effect free, we need a way to
handle these side-effects. Sometimes we can put this logic with our action creator services,
and that works for simple cases, but often times the same block of logic needs to run in
response to multiple action types.
338
Side Effects
@Injectable()
export class CustomizationEffects {
constructor(
private actions$: Actions,
private apiService: ApiService
) {
@Effect()
login$ = this.actions$
.ofType(SessionActions.LOGIN_SEND_SUCCESS)
.mergeMap<Action>(action => this.apiService.getCustomizations(action.payload.userI
d)
.map(result => createAction(CustomizationActions.CUSTOMIZATIONS_RETRIEVE_SUCCESS
, result.json()))
.catch(error => Observable.of(createAction(CustomizationActions.CUSTOMIZATIONS_R
ETRIEVE_ERROR, error.json())))
);
In this example, when the LOGIN_SEND_SUCCESS action occurs from anywhere in the
application, we make a request to the server to fetch the user's customizations given their
userId , which has been attached to the payload of this action. Regardless if this requests
succeeds or fails, we need to create and return an Observable that is bound to the new
action we'd like Redux to perform, such as storing the customizations when the request is
successful, or processing the error returned by the server if there's an error.
To tell @ngrx/effects which Observable objects are side-effects to associate them with
Redux, we need to provide a hint using the @Effect() decorator. Without it, your side-effect
will not run.
339
Side Effects
// ...
import {EffectsModule} from '@ngrx/effects';
@NgModule({
imports: [
// ...
EffectsModule.run(CustomizationEffects)
],
// ...
})
export class AppModule { }
340
Getting More From Redux and @ngrx
Redux
Redux has a number of tools and middleware available in its ecosystem to facilitate elegant
app development.
Redux DevTools - a tool that displays a linear timeline of actions that have interacted
with its store. Allows for replaying actions and error handling
redux-thunk - middleware that enables lazy evaluation of actions
redux-observable - an RxJS-based model for handling side-effects on action streams.
*ng2-redux-router - reactive glue between the Angular router and your redux store.
@ngrx
@ngrx provides most of its Redux implementation through the ngrx/store module. Other
modules are available for better integration and development.
341
TDD Testing
TDD Testing
Test-Driven-Development is an engineering process in which the developer writes an initial
automated test case that defines a feature, then writes the minimum amount of code to pass
the test and eventually refactors the code to acceptable standards.
A unit test is used to test individual components of the system. An integration test is a test
which tests the system as a whole, and how it will run in production.
Unit tests should only verify the behavior of a specific unit of code. If the unit's behavior is
modified, then the unit test would be updated as well. Unit tests should not make
assumptions about the behavior of other parts of your codebase or your dependencies.
When other parts of your codebase are modified, your unit tests should not fail. (Any failure
indicates a test that relies on other components and is therefore not a unit test.) Unit tests
are cheap to maintain and should only be updated when the individual units are modified.
For TDD in Angular, a unit is most commonly defined as a class, pipe, component, or
service. It is important to keep units relatively small. This helps you write small tests which
are "self-documenting", where they are easy to read and understand.
342
The Testing Toolchain
Jasmine
Karma
Phantom-js
Istanbul
Sinon
Chai
Jasmine is the most popular testing framework in the Angular community. This is the core
framework that we will write our unit tests with.
Karma is a test automation tool for controlling the execution of our tests and what browser to
perform them under. It also allows us to generate various reports on the results. For one or
two tests this may seem like overkill, but as an application grows larger and the number of
units to test grows, it is important to organize, execute and report on tests in an efficient
manner. Karma is library agnostic so we could use other testing frameworks in combination
with other tools (like code coverage reports, spy testing, e2e, etc.).
In order to test our Angular application we must create an environment for it to run in. We
could use a browser like Chrome or Firefox to accomplish this (Karma supports in-browser
testing), or we could use a browser-less environment to test our application, which can offer
us greater control over automating certain tasks and managing our testing workflow.
PhantomJS provides a JavaScript API that allows us to create a headless DOM instance
which can be used to bootstrap our Angular application. Then, using that DOM instance that
is running our Angular application, we can run our tests.
Istanbul is used by Karma to generate code coverage reports, which tells us the overall
percentage of our application being tested. This is a great way to track which
components/services/pipes/etc. have tests written and which don't. We can get some useful
insight into how much of the application is being tested and where.
For some extra testing functionality we can use the Sinon library for things like test spys, test
subs and mock XHR requests. This is not necessarily required as Jasmine comes with the
spyOn function for incorporating spy tests.
Chai is an assertion library that can be paired with any other testing framework. It offers
some syntactic sugar that lets us write our unit tests with different verbiage - we can use a
should, expect or assert interface. Chai also takes advantage of "function chaining" to form
343
The Testing Toolchain
English-like sentences used to describe tests in a more user friendly way. Chai isn't a
required library for testing and we won't explore it much more in this handout, but it is a
useful tool for creating cleaner, more well-written tests.
344
Test Setup
Test Setup
The repo angular2-redux-starter is a basic webpack-based Angular application (with Redux)
with the same testing toolchain outlined above. Let's take a look at how this project is set up.
345
Filename Conventions
Filename Conventions
Each unit test is put into its own separate file. The Angular team recommends putting unit
test scripts alongside the files they are testing and using a .spec filename extension to
mark it as a testing script (this is a Jasmine convention). So if you had a component
/app/components/mycomponent.ts , then your unit test for this component would be in
your testing scripts wherever you like, though keeping them close to your source files makes
them easier to find and gives those who aren't familiar with the source code an idea of how
that particular piece of code should work.
346
Karma Configuration
Karma Configuration
Karma is the foundation of our testing workflow. It brings together our other testing tools to
define the framework we want to use, the environment to test under, the specific actions we
want to perform, etc. In order to do this Karma relies on a configuration file named by default
karma.conf.js.
You can seed a new configuration file though the karma init command, which will guide
you through a few basic questions to get a bare minimum setup running.
Overview
The configuration file is put together by exporting a function that accepts the configuration
object that Karma is going to work with. Modifying certain properties on this object will tell
Karma what it is we want to do. Let's go over some of the key properties used in this
configuration file:
config.set({
frameworks: [...],
plugins: [ ... ],
files: [ ... ],
preprocessors: { ... },
webpack: { ... },
reporters: [ ... ],
coverageReporter: { ... },
port: 9999,
browsers: ['Chrome'], // Alternatively: 'PhantomJS'
colors: true,
logLevel: config.LOG_INFO,
autoWatch: true,
captureTimeout: 6000,
});
};
frameworks
347
Karma Configuration
frameworks: [
'jasmine',
],
frameworks is a list of the testing frameworks we want to use. These frameworks must be
plugins
plugins: [
'karma-jasmine',
'karma-webpack',
'karma-coverage',
'karma-remap-istanbul',
'karma-chrome-launcher',
],
Plugins that integrate karma with testing frameworks like Jasmine or build systems like
Webpack.
files
files: [
'./src/tests.entry.ts',
{
pattern: '**/*.map',
served: true,
included: false,
watched: true,
},
],
files is a list of files to be loaded into the browser/testing environment. These are loaded
sequentially, so order matters. The file list can also take the form of a glob pattern as it
becomes rather tedious to manually add in a new file for each new testing script created.
In the angular2-redux-starter karma.conf.js we have put the testing files we wish to include in
a separate file - src/tests.entry.ts, which includes a require call using a regex pattern for
importing files with the .spec.ts file extension. As a project grows larger and the number of
files to include grows in complexity it is good practice to put file imports in a separate file -
this keeps the karma.conf.js file cleaner and more readable. Here is what our
src/tests.entry.ts looks like:
348
Karma Configuration
preprocessors
preprocessors: {
'./src/tests.entry.ts': [
'webpack',
'sourcemap',
],
'./src/**/!(*.test|tests.*).(ts|js)': [
'sourcemap',
],
}
preprocessors allow for some operation to be performed on the contents of a unit testing
file before it is executed. These operations are carried out through the use of Karma plugins
and are often used for transpiling operations. Since we are writing unit tests in TypeScript,
.ts files must be transpiled into plain Javascript in order to run in a browser-based
environment.
source map files originating from transpilation through the sourcemap processor.
webpack
349
Karma Configuration
webpack: {
plugins,
entry: './src/tests.entry.ts',
devtool: 'inline-source-map',
resolve: {
extensions: ['.webpack.js', '.web.js', '.ts', '.js'],
},
module: {
rules:
combinedLoaders().concat(
config.singleRun
? [ loaders.istanbulInstrumenter ]
: [ ]),
},
stats: { colors: true, reasons: true },
},
webpackServer: {
noInfo: true, // prevent console spamming when running in Karma!
}
If the project uses webpack, then the property webpack in the Karma configuration object is
where we can configure webpack with Karma. In the angular2-redux-starter, plugins and
loaders are exported from their own files to be imported by both the webpack config and the
karma config, making the configuration object smaller.
Using webpack, we can configure how to bundle our unit tests; that is, whether to pack all
tests into a single bundle, or each unit test in its own bundle, etc. Regardless, unit tests
should not be bundled with the rest of the applications code (especially in production!). In
angular2-redux-starter we have opted to bundle all unit tests together.
350
Karma Configuration
reporters: ['spec']
.concat(coverage)
.concat(coverage.length > 0 ? ['karma-remap-istanbul'] : []),
remapIstanbulReporter: {
src: 'coverage/chrome/coverage-final.json',
reports: {
html: 'coverage',
},
},
coverageReporter: {
reporters: [
{ type: 'json' },
],
dir: './coverage/',
subdir: (browser) => {
return browser.toLowerCase().split(/[ /-]/)[0]; // returns 'chrome'
},
},
coverageReporter is used to configure the output of results of our code coverage tool (our
toolchain uses Istanbul). Here we have specified to output the results in JSON and HTML.
Reports will appear in the coverage/ folder.
reporters is a list of reporters to use in the test cycle. Reporters can be thought of as
modular tools used to report on some aspect of the testing routine outside of the core unit
tests. Code coverage is an example of a reporter - we want it to report on how much of our
code is being tested. There are many more reporters available for Karma that can aid in
crafting your testing workflow.
Environment configuration
port: 9999,
browsers: ['Chrome'], // Alternatively: 'PhantomJS'
colors: true,
logLevel: config.LOG_INFO,
autoWatch: true,
captureTimeout: 6000,
port , browsers and singleRun configure the environment our unit tests will run under.
The browsers property specifies which browser we want Karma to launch and capture
output from. We can use Chrome, Firefox, Safari, IE or Opera (requires additional Karma
launcher to be installed for each respective browser). For a browser-less DOM instance we
can use PhantomJS (as outlined in the toolchain section).
351
Karma Configuration
default value is 9876 if not specified). The property singleRun controls how Karma
executes, if set to true , Karma will start, launch configured browsers, run tests and then
exit with a code of either 0 or 1 depending on whether or not all tests passed.
Completed Configuration
The net result of customizing all of these proprties is the karma.conf.js file in angular-redux-
starter.
Additional Resources
This is just a sample of the core properties in karma.conf.js being used by angular2-redux-
starter project. There are many more properties that can be used to extend and configure
the functionality of Karma - take a look at the official documentation for the full API
breakdown.
352
TestBed Configuration (Optional)
import {
getTestBed,
ComponentFixtureAutoDetect,
TestBed,
} from '@angular/core/testing';
import {
BrowserDynamicTestingModule,
platformBrowserDynamicTesting,
} from '@angular/platform-browser-dynamic/testing';
if (testBed.platform == null) {
testBed.initTestEnvironment(
BrowserDynamicTestingModule,
platformBrowserDynamicTesting());
}
testBed.configureCompiler({
providers: [
{provide: ComponentFixtureAutoDetect, useValue: true},
]
});
configure(testBed);
tests.configure.ts creates the testing platform if it doesn't already exist, compiles the
template, and exports configureTests which can then be imported and used in our unit
tests.
353
TestBed Configuration (Optional)
beforeEach(done => {
const configure = (testBed: TestBed) => {
testBed.configureTestingModule({
imports: [AppModule],
});
};
configureTests(configure).then(testBed => {
fixture = testBed.createComponent(ExampleComponent);
fixture.detectChanges();
done();
});
});
354
Typings
Typings
Since our project and unit tests are written in TypeScript, we need type definitions for the
libraries we'll be writing our tests with (Chai and Jasmine). In angular2-redux-example we
have included these type definitions from @types .
355
Executing Test Scripts
A good practice is to amalgamate all the project's task/build commands through npm. This
gives continuity to your build process and makes it easier for people to test/run your
application without knowing your exact technology stack. In package.json the scripts field
holds an object with key-value pairing, where the key is the alias for the command and the
value is the command to be executed.
...
"scripts": {
"test": "karma start",
...
}
...
Now running npm test will start Karma. Below is the output of our Karma test. As you can
see we had one test that passed, running in a Chrome 48 browser.
Figure: image
356
Simple Test
Simple Test
To begin, let's start by writing a simple test in Jasmine.
Though this test may be trivial, it illustrates the basic elements of a unit test. We explain
what this test is for by using describe , and we use it to assert what kind of result we are
expecting from our test. These are user-defined so it's a good idea to be as descriptive and
accurate in these messages as possible. Messages like "should work", or "testing service"
don't really explain exactly what's going on and may be confusing when running multiple
tests across an entire application.
Our actual test is basic, we use expect to formulate a scenario and use toEqual to assert
the resulting condition we are expecting from that scenario. The test will pass if our assertion
is equal to the resulting condition, and fail otherwise. You always want your tests to pass -
do not write tests that have the results you want in a failed state.
357
Using Chai
Using Chai
Chai is an assertion library with some tasty syntax sugar that can be paired with any other
testing framework. It lets us write tests in a TDD (Test Driven Development) style or BDD
(Behavior Driven Development) style. We already know what TDD is (read the intro!), so
what exactly is BDD? Well BDD is the combination of using TDD with natural language
constructs (English-like sentences) to express the behavior and outcomes of unit tests.
Jasmine already uses a TDD style, so we'll be using Chai for its BDD interfaces, mainly
through the use of should and expect .
The expect and should interface both take advantage of chaining to construct English-like
sentences for describing tests. Once you've decided on a style you should maintain that
style for all your other tests. Each style has its own unique syntax; refer to the
documentation for that specific API.
358
Testing Components
Testing Components
Testing Angular components requires some insight into the Angular @angular/core/testing
module. Though many features of Jasmine are used in Angulars testing module there are
some very specific wrappers and routines that Angular requires when testing components.
359
Verifying Methods and Properties
message.component.ts
@Component({
selector: 'display-message',
template: '<h1>{{message}}</h1>'
})
constructor() {}
setMessage(newMessage: string) {
this.message = newMessage;
}
clearMessage() {
this.message = '';
}
}
Now for our unit test. We'll create two tests, one to test the setMessage function to see if the
new message shows up and another to test the clearMessage function to see if clearing the
message works as expected.
message.spec.ts
360
Verifying Methods and Properties
beforeEach(() => {
app = new MessageComponent();
});
View Example
We have created two tests: one for setMessage and the other for clearMessage . In order to
call those functions we must first initialize the MessageComponent class. This is accomplished
by calling the beforeEach function before each test is performed.
Once our MessageComponent object is created we can call setMessage and clearMessage
and analyze the results of those actions. We formulate an expected result, and then test to
see if the result we were expecting came to be. Here we are testing whether or not the
message we tried to set modified the MessageComponent property message to the value we
intended. If it did, then the test was successful and our MessageComponent works as
expected.
361
Injecting Dependencies and DOM Changes
quote.component.ts
@Component({
selector: 'my-quote',
template: '<h3>Random Quote</h3> <div>{{quote}}</div>'
})
getQuote() {
this.quoteService.getQuote().then((quote) => {
this.quote = quote;
});
};
}
This component relies on the QuoteService to get a random quote, which it will then display.
The class is pretty simple - it only has the getQuote function that will modify the DOM,
therefore it will be our main area of focus in testing.
In order to test this component we need initiate the QuoteComponent class. The Angular
testing library offers a utility called TestBed . This allows us to configure a testing module
where we can provided mocked dependencies. Additionally it will create the component for
us and return a component fixture that we can perform testing operations on.
quote.spec.ts
362
Injecting Dependencies and DOM Changes
class MockQuoteService {
public quote: string = 'Test quote';
getQuote() {
return Promise.resolve(this.quote);
}
}
let fixture;
beforeEach(() => {
TestBed.initTestEnvironment(
BrowserDynamicTestingModule,
platformBrowserDynamicTesting()
);
TestBed.configureTestingModule({
declarations: [
QuoteComponent
],
providers: [
{ provide: QuoteService, useClass: MockQuoteService }
]
});
fixture = TestBed.createComponent(QuoteComponent);
fixture.detectChanges();
});
363
Injecting Dependencies and DOM Changes
expect(compiled.querySelector('div').innerText).toEqual('Test quote');
});
})));
});
View Example
to create the component, pass in any dependencies, trigger the component to perform an
action and then look at the DOM to see if the action is what we expected.
Let's take a look at how this is accomplished with the above unit test.
also imported from angular and allow the application to be bootstrapped for testing. This is
necessary for all unit tests that make use of TestBed . Notice that this platform is destroyed
and reset before each test runs.
In the Should get quote test we have gotten access to our component through the
fixture.componentInstance property. We then call getQuote to kickstart our only action in
the QuoteComponent component. We run the test when the fixture is stable by using its
whenStable method which will ensure the promise inside the getQuote() has resolved,
giving the component a chance to set the quote value. We call fixture.detectChanges to
keep an eye out for any changes taking place to the DOM, and use the
fixture.debugElement.nativeElement property to get access to those underlying DOM
elements.
364
Injecting Dependencies and DOM Changes
Now we can check to see if the DOM rendered by our QuoteComponent contains the quote
that we mocked in through the QuoteService . The final line attempts to assert that the
DOM's div tag contains the mocked quote 'Test Quote' inside. If it does, then our component
passes the test and works as expected; if it doesn't, that means our component is not
outputting quotes correctly.
We wrap Should get quote test in async() . This is to allow our tests run in an
asynchronous test zone. Using async creates a test zone which will ensure that all
asynchronous functions have resolved prior to ending the test.
365
Injecting Dependencies and DOM Changes
overrideModule
overrideComponent
overrideDirective
overridePipe
For example, you might want to override the template of a component. This is useful for
testing a small part of a large component, as you can ignore the output from the rest of the
DOM and only focus on the part you are interested in testing.
@Component({
selector: 'display-message',
template: `
<div>
<div>
<h1>{{message}}</h1>
<div>
</div>
`
})
export class MessageComponent {
public message: string = '';
setMessage(newMessage: string) {
this.message = newMessage;
}
}
366
Injecting Dependencies and DOM Changes
describe('MessageComponent', () => {
let fixture;
beforeEach(() => {
TestBed.configureTestingModule({
declarations: [MessageComponent],
providers: []
});
fixture = TestBed.overrideComponent(MessageComponent, {
set: {
template: '<span>{{message}}</span>'
}})
.createComponent(MessageComponent);
fixture.detectChanges();
});
});
View Example
367
Testing Asynchronous Actions
Let's go back to the example of the QuoteComponent component and rewrite the unit test
using fakeAsync :
@Component({
selector: 'my-quote',
template: '<h3>Random Quote</h3> <div>{{quote}}</div>'
})
getQuote() {
this.quoteService.getQuote().then((quote) => {
this.quote = quote;
});
};
}
368
Testing Asynchronous Actions
class MockQuoteService {
public quote: string = 'Test quote';
getQuote() {
return Promise.resolve(this.quote);
}
}
let fixture;
beforeEach(() => {
TestBed.configureTestingModule({
declarations: [
QuoteComponent
],
providers: [
{ provide: QuoteService, useClass: MockQuoteService }
]
});
fixture = TestBed.createComponent(QuoteComponent);
fixture.detectChanges();
});
View Example
369
Testing Asynchronous Actions
calling tick() . We can then run detectChanges and query the DOM for our expected
result.
370
Refactoring Hard-to-Test Code
371
Testing Services
Testing Services
When testing services in Angular we employ many of the same techniques and strategies
used for testing components. Services, like components, are classes with methods and
properties that we want to verify. Data is the main emphasis in testing services - are we
getting, storing and propagating data correctly.
372
Testing Strategies for Services
Injecting Dependencies
Like components, services often require dependencies that Angular injects through the
constructor of the service's class. Since we are initializing these classes outside the
bootstrapping process of Angular, we must explicitly inject these dependencies ourselves.
This is accomplished by using the TestBed to configure a testing module and feed in
required dependencies like the HTTP module.
373
Testing HTTP Requests
The basic strategy for testing such a service is to verify the contents of the request being
made (correct URL) and ensure that the data we mock into the service is returned correctly
by the right method.
wikisearch.ts
@Injectable()
export class SearchWiki {
constructor (private http: Http) {}
Here is a basic service. It will query Wikipedia with a search term and return an Observable
with the results of the query. The search function will make a GET request with the supplied
term, and the searchXML method will do the same thing, except request the response to be
in XML instead of JSON. As you can see, it depends on the HTTP module to make a request
to wikipedia.org.
374
Testing HTTP Requests
Our testing strategy will be to check to see that the service has requested the right URL, and
once we've responded with mock data we want to verify that it returns that same data.
375
Testing HTTP Requests
The configured MockBackend can then be injected into HTTP, so any calls to the service,
such as http.get will return our expected data, allowing us to test our service in isolation
from real network traffic.
wikisearch.spec.ts
import {
fakeAsync,
inject,
TestBed
} from '@angular/core/testing';
import {
HttpModule,
XHRBackend,
ResponseOptions,
Response,
RequestMethod
} from '@angular/http';
import {
MockBackend,
MockConnection
} from '@angular/http/testing/mock_backend';
const mockResponse = {
"batchcomplete": "",
"continue": {
"sroffset": 10,
"continue": "-||"
},
"query": {
"searchinfo": {
"totalhits": 36853
},
"search": [{
"ns": 0,
"title": "Stuff",
376
Testing HTTP Requests
"snippet": "<span></span>",
"size": 1906,
"wordcount": 204,
"timestamp": "2016-06-10T17:25:36Z"
}]
}
};
beforeEach(() => {
TestBed.configureTestingModule({
imports: [HttpModule],
providers: [
{
provide: XHRBackend,
useClass: MockBackend
},
SearchWiki
]
});
});
mockBackend.connections.subscribe(
(connection: MockConnection) => {
expect(connection.request.method).toBe(RequestMethod.Get);
expect(connection.request.url).toBe(expectedUrl);
connection.mockRespond(new Response(
new ResponseOptions({ body: mockResponse })
));
});
searchWiki.search('Angular')
.subscribe(res => {
expect(res).toEqual(mockResponse);
});
})
));
377
Testing HTTP Requests
expect(searchWiki.foo).toEqual('food');
})
));
});
View Example
We use inject to inject the SearchWiki service and the MockBackend into our test. We
then wrap our entire test with a call to fakeAsync , which will be used to control the
asynchronous behavior of the SearchWiki service for testing.
Next, we subscribe to any incoming connections from our back-end. This gives us access
to an object MockConnection , which allows us to configure the response we want to send out
from our back-end, as well as test any incoming requests from the service we're testing.
In our example, we want to verify that the SearchWiki 's search method makes a GET
request to the correct URL. This is accomplished by looking at the request object we get
when our SearchWiki service makes a connection to our mock back-end. Analyzing the
request.url property we can see if its value is what we expect it to be. Here we are only
checking the URL, but in other scenarios we can see if certain headers have been set, or if
certain POST data has been sent.
Now, using the MockConnection object we mock in some arbitrary data. We create a new
ResponseOptions object where we can configure the properties of our response. This follows
the format of a regular Angular Response class. Here we have simply set the body property
to that of a basic search result set you might see from Wikipedia. We could have also set
things like cookies, HTTP headers, etc., or set the status value to a non-200 state to test
how our service responds to errors. Once we have our ResponseOptions configured we
create a new instance of a Respond object and tell our back-end to start using this as a
response by calling .mockRespond .
It is possible to use multiple responses. Say your service had two possible GET requests -
one for /api/users , and another /api/users/1 . Each of these requests has a different
corresponding set of mock data. When receiving a new connection through the MockBackend
subscription, you can check to see what type of URL is being requested and respond with
whatever set of mock data makes sense.
Finally, we can test the search method of the SearchWiki service by calling it and
subscribing to the result. Once our search process has finished, we check the result object
to see if it contains the same data that we mocked into our back-end. If it is, then
congratulations, your test has passed.
378
Testing HTTP Requests
In the should set foo with a 1s delay test, you will notice that we call tick(1000) which
simulates a 1 second delay.
379
Testing HTTP Requests
This method still allows us to check to see that the service has requested the right URL, and
that it returns that expected data.
wikisearch.spec.ts
import {
fakeAsync,
inject,
TestBed
} from '@angular/core/testing';
import {
HttpModule,
Http,
ResponseOptions,
Response
} from '@angular/http';
import { Observable } from 'rxjs/Observable';
import 'rxjs/add/observable/of';
import {SearchWiki} from './wikisearch.service';
const mockResponse = {
"batchcomplete": "",
"continue": {
"sroffset": 10,
"continue": "-||"
},
"query": {
"searchinfo": {
"totalhits": 36853
},
"search": [{
"ns": 0,
"title": "Stuff",
"snippet": "<span></span>",
"size": 1906,
"wordcount": 204,
"timestamp": "2016-06-10T17:25:36Z"
}]
}
};
380
Testing HTTP Requests
beforeEach(() => {
mockHttp = { get: null } as Http;
spyOn(mockHttp, 'get').and.returnValue(Observable.of({
json: () => mockResponse
}));
TestBed.configureTestingModule({
imports: [HttpModule],
providers: [
{
provide: Http,
useValue: mockHttp
},
SearchWiki
]
});
});
searchWiki.search('Angular')
.subscribe(res => {
expect(mockHttp.get).toHaveBeenCalledWith(expectedUrl);
expect(res).toEqual(mockResponse);
});
})
));
});
View Example
381
Testing HTTP Requests
Unfortunately services that use the JSONP module use a significantly different class for
mocking the back-end. The class MockBrowserJsonp is used for this scenario.
382
Executing Tests Asynchronously
Instead of only using inject , we use fakeAsync to wrap it and fulfill dependencies and
execute the test in an asynchronous process. Using fakeAsync requires us to return a
Promise, which we use to resolve the competition of our test by calling pass , or fail ,
depending on the results of our test.
383
Testing Redux
Testing Redux
Unit testing Redux is a very straightforward process. There are two primary units:
Actions trigger changes in a Redux system. There are two broad categories of actions:
synchronous (which are quite simple to test) and asynchronous (which are slightly more
involved).
The examples below should provide you with a strong foundation for testing Redux
applications.
384
Testing Simple Actions
@Injectable
export class CounterActions {
constructor(private redux: NgRedux<any>) {}
increment() {
this.redux.dispatch({ type: INCREMENT_COUNTER });
}
decrement() {
this.redux.dispatch({ type: DECREMENT_COUNTER });
}
}
385
Testing Simple Actions
// Mock out the NgRedux class with just enough to test what we want.
class MockRedux extends NgRedux<any> {
constructor() {
super(null);
}
dispatch = () => undefined;
}
beforeEach(() => {
// Initialize mock NgRedux and create a new instance of the
// ActionCreatorService to be tested.
mockRedux = new MockRedux();
actions = new CounterActions(mockRedux);
});
spyOn(mockRedux, 'dispatch');
actions.increment();
expect(mockRedux.dispatch).toHaveBeenCalled();
expect(mockRedux.dispatch).toHaveBeenCalledWith(expectedAction);
});
spyOn(mockRedux, 'dispatch');
actions.decrement();
expect(mockRedux.dispatch).toHaveBeenCalled();
expect(mockRedux.dispatch).toHaveBeenCalledWith(expectedAction);
});
});
386
Testing Simple Actions
We just make sure that our action creators do indeed dispatch the correct actions.
387
Testing Complex Actions
A Conditional Action
Consider the following conditional action (i.e., one that is fired depending on current state):
@Injectable()
export class MyActionService {
constructor(private redux: NgRedux) {};
// A conditional action
incrementIfOdd() {
const { counter } = this.redux.getState();
Unit testing is similar to before, but we need to mock our state as well as dispatch:
388
Testing Complex Actions
beforeEach(() => {
// Our mock NgRedux can now accept mock state as a constructor param.
mockRedux = new MockRedux(mockState);
actions = new CounterActions(mockRedux);
});
mockState.counter = 3;
spyOn(mockRedux, 'dispatch');
actions.incrementIfOdd();
expect(mockRedux.dispatch).toHaveBeenCalled();
expect(mockRedux.dispatch).toHaveBeenCalledWith(expectedAction);
});
expect(mockRedux.dispatch).not.toHaveBeenCalled();
});
});
An Async Action
389
Testing Complex Actions
@Injectable()
export class CounterActions {
constructor(private redux: NgRedux<any>) {}
// ...
incrementAsync(timeInMs = 1000) {
this.delay(timeInMs).then(() => this.redux.dispatch({ type: INCREMENT_COUNTER }));
}
private delay(timeInMs) {
return new Promise((resolve,reject) => {
setTimeout(() => resolve() , timeInMs);
});
}
}
We can test this using the normal techniques for async service functions:
If we can make incrementAsync return a promise, we can just return a promise from the
test and jasmine will wait until it settles.
Alternately, we can use the fakeAsync technique discussed in the section on testing
components.
The thing to remember is that if we follow the ActionCreatorService pattern, our actions are
just functions on an Angular service. So we can mock out NgRedux (and any other
dependencies) and just test it as we would any other Angular service.
390
Testing Reducers
Testing Reducers
Luckily, testing reducers is a lot like testing our synchronous action creators, since all
reducer operations are synchronous. This plays a big role in making our global state easy to
keep track of, which is why we're big fans of Redux.
As you can see, there are three cases to test: the default case, the increment and the
decrement. We want to test that our actions trigger the state changes we expect from the
reducer.
391
Testing Reducers
Note that we're only testing the section of Redux state that the counter reducer is
responsible for, and not the whole. We can see from these tests that Redux is largely built
on pure functions.
392
Afterthoughts
Afterthoughts
The examples outlined above are just one approach to unit testing in Redux. During actual
development it might prove to be too costly to maintain tests for every action and reducer,
and in some cases even trivial (i.e. should I be paranoid about this JSON object with one
property being returned?).
Another approach we've tried is to treat the overall state change in the store triggered by an
action (or by a series of actions) as a single unit - in the Redux world reducers don't function
without actions and vice versa, so why separate them? This leaves more flexibility when
making changes to actions and reducers without losing scope of what Redux is doing for our
app.
393
Migrating Angular 1.x Projects to Angular 2
394
Migration Prep
Migration Prep
Before most Angular 1.x applications can be upgraded to Angular 2 there is preparatory
work to do. This is especially true for Angular applications using style that predates Angular
1.3.
395
Upgrading To Angular 1.3+ Style
All controllers should be in controllerAs form, and ideally should only exist on
directives
Use directives, specifically "component directives", that use the following properties:
restrict: 'E'
scope: {}
bindToController: {}
controllerAs
template or templateUrl
transclude (optional)
require (optional)
compile
replace: true
priority / terminal
396
Using Webpack
Using Webpack
Using a module loader like webpack is essential for migrating to Angular, and should already
be part of every modern programmer's tool set. Webpack will make it easy to manage all the
different files that a modern, modular Angular 1.3+ project prescribes. This includes bundling
the application for distribution or deployment.
Using webpack will also simplify a programmer's Angular workflow, since the easiest way to
work with Angular is with TypeScript, or ES6, neither of which works natively in
contemporary browsers.
397
Migrating To TypeScript
Migrating to TypeScript
TypeScript is a superset of ES6 and, as its name suggests, uses a type system. This can
have an enormous impact on developer tools, providing richer auto-complete and static
analysis.
Angular was built using TypeScript, and supports decorators which provide meta information
to Angular. While it is possible to use Angular without these features, the syntax feels more
"natural" with TypeScript's decorators.
398
Choosing an Upgrade Path
Total conversion
ng-upgrade
ng-metadata
399
Avoiding Total Conversion
Total Conversion
Completely converting an application from Angular 1 to Angular 2 is technically possible, but
really only suitable for the smallest applications. Even small applications can be tricky to
totally convert if they're not well structured.
400
Using ng-metadata (Angular 1.x Using 2 Style)
Once an application is converted to ng-metadata style it is very close to Angular 2, but still
requires refactoring. In most cases, ng-metadata is not as efficient as ng-upgrade with
respect to refactoring time. The payload of an ng-metadata application is smaller, and
porting to ng-metadata can be done in an even more ad-hoc fashion than with ng-upgrade.
401
Bootstrapping ng-metadata
Bootstrapping ng-metadata
ng-metadata provides @NgModule from Angular 2 to Angular 1. To use @NgModule , update
your application bootstrap from angular.bootstrap to the example below.
Bootstrap (bootstrap.ts)
import { platformBrowserDynamic } from 'ng-metadata/platform-browser-dynamic';
import { AppModule } from './app.module';
platformBrowserDynamic().bootstrapModule(AppModule);
@NgModule({
declarations: [AppComponent, HeroComponent],
providers: [HeroService]
})
export class AppModule {}
402
Components and Services
Components
Components use @Component from ng-metadata. Lifecycle hooks similar to those in Angular
should work with ng-metadata.
@Component({
selector: 'hero',
templateUrl: './hero.component.html'
})
export class HeroComponent implements OnInit {
@Input() name: string;
@Output() call = new EventEmitter<void>();
ngOnInit() {
console.log('Component initialized');
}
}
Services
Services use @Injectable from ng-metadata. This decorator is written preceding a
TypeScript class. Angular 1 services can be added by using the @Inject decorator in the
service constructor.
403
Components and Services
@Injectable()
export class HeroService {
constructor(@Inject('$http') private $http: ng.IHttpService){
}
fetchAll(){
return this.$http.get('/api/heroes');
}
}
404
Using ng-upgrade (Angular 1.x Coexisting With Angular 2)
405
Order of Operations
Order of Operations
Migrating a large Angular 1 application to Angular 2 can be a big undertaking. We
recommend the following order of operations during conversion.
Webpack
TypeScript
Move as much code as possible into pure TypeScript modules
Write framework-agnostic unit tests for that code
Good candidates for this are stateless services
Enable ngUpgrade
If used, replace the ng-app directive with angular.bootstrap .
Create UpgradeAdapter singleton and replace "bootstrap".
Identify components (directives) of the app most likely to benefit from Angular 2
These could be parts of the app where performance is a problem, parts where
there will be more active development or parts that could really benefit from
Angular 2 libraries or components.
Convert all service dependencies from Angular 1 to Angular 2
Move existing .factory Angular services to .service
Leverage TypeScript classes
Use upgradeAdapter.downgradeNg2Provider(ServiceName) to expose Angular 2
service to Angular 1
Repeat this process until all components have been converted to Angular 2
406
Replacing Services with TypeScript Classes
During conversion, we will introduce Webpack as a module loader. For services that lack
state and don't heavily rely on other dependency injected services, we recommend rewriting
them using TypeScript modules. The advantages of writing code this way are:
Even services that depend on a limited set of Angular 1 services (e.g. $http ) can be
rewritten by depending on other libraries (e.g. window.fetch ).
Example
.factory original
407
Replacing Services with TypeScript Classes
angular.module('calcapp', [])
.factory('CalculatorService', function () {
return {
square: function (a) {
return a*a;
},
cube: function (a) {
return a*a*a;
}
};
});
Conversion to .service
angular.module('calcapp', [])
.service('CalculatorService', function () {
this.square = function (a) {
return a*a;
};
class CalculatorService {
square (a) {
return a*a;
}
cube (a) {
return a*a*a;
}
}
angular.module('calcapp', [])
.service('CalculatorService', CalculatorService);
408
Replacing Services with TypeScript Classes
// elsewhere
import {CalculatorService} from './calculator.service';
409
Bootstrapping ng-upgrade
Bootstrapping ng-upgrade
Use manual Angular 1.x bootstrapping, and remove ng-app / ng-strict-di references
if they exist
Add Angular 2 dependencies
Add the upgrade adapter import {UpgradeAdapter} from '@angular/upgrade'
Call the upgrade adapter's bootstrap
Once this is working the foundation is set for transitioning from Angular 1.x to Angular 2. It is
important to note that the upgrade adapter's bootstrap mechanism is asynchronous.
Additionally it's important to treat the upgrade adapter as a singleton.
@NgModule({
declarations: [],
providers: [],
imports: [BrowserModule]
})
export class AppModule {
}
410
Bootstrapping ng-upgrade
The above example does not actually do anything other than bootstrap an empty application.
Upgrading/Downgrading Components
Once bootstrapping is complete, Angular 1.x components can be upgraded to work with
Angular 2. Conversely, Angular 2 components can be downgraded to work with Angular 1.x.
411
Downgrading Components
Downgrading Components
Upgrading components sounds like it should happen before downgrading, but the point of
upgrading is to make an Angular 1.x component work with Angular 2. For an Angular 2
component to use an Angular 1.x component in an ng-upgrade application there must first
be a downgraded Angular 2 component. Consequently it's important to first learn how to
downgrade Angular 2 components to work with Angular 1.x
All downgraded components operate like Angular 1.x 'E' element directives.
@Component({
selector: 'a2-downgrade',
template: '<p>{{ message }}</p>'
})
export class A2DowngradeComponent {
message = `What you're seeing here is an Angular2 component ` +
`running in an Angular1 app!`;
}
412
Upgrading Components
Upgrading Components
The only Angular 1.x components that can be upgraded and used in Angular 2 code are
those that strictly follow the component pattern outlined at the top of this document.
Wherever possible use Angular 1.5+'s .component .
class Upgradable {
message = 'I am an Angular 1 Directive';
}
angular.module('app').component('a1Upgradable', {
controller: Upgradable,
template: `<span>{{ a1Upgradable.message }}</span>`
});
class Upgradable {
message = 'I am an Angular 1 Directive';
}
Below is an Angular 2 component that will use the upgraded Angular 1.x directive:
413
Upgrading Components
@NgModule({
declarations: [upgradeAdapter.upgradeNg1Component('a1Upgradable'), A2UsingA1Componen
t],
providers: [],
imports: [BrowserModule]
})
export class AppModule {
}
@Component({
selector: 'a2-using-a1',
template: `<p>{{ message }}<a1-upgradable></a1-upgradable></p>`
})
export class A2UsingA1Component {
message = 'Angular 2 Using Angular 1: ';
}
414
Projecting Angular 1 Content into Angular 2 Components
This is what a simple Angular 2 component that supports projection looks like:
@Component({
selector: 'a2-projection',
template: `
<p>
Angular 2 Outer Component (Top)
<ng-content></ng-content>
Angular 2 Outer Component (Bottom)
</p>
`
})
export class A2Projection { }
Here's a very simple Angular 1.x directive that will be projected into the Angular 2
component:
class A1ProjectionContents {
message = 'I am an Angular 1 Directive "projected" into Angular 2';
}
Both the component and the directive must be registered with Angular 1.x:
415
Projecting Angular 1 Content into Angular 2 Components
<a2-projection>
<a1-projection-content></a1-projection-content>
</a2-projection>
416
Transcluding Angular 2 Components into Angular 1 Directives
@Component ({
selector: 'a2-transclusion-contents',
template: `<p>{{ message }}</p>`
})
export class A2Transclusion {
message =
'I am an Angular 2 Component "transcluded" into Angular 1.x';
}
class A1Transclusion {
}
Angular 1.x needs to know about both the component and the directive:
417
Transcluding Angular 2 Components into Angular 1 Directives
Finally, Angular 2 content can be transcluded into Angular 1.x like so:
<a1-transclude>
<a2-transclusion-contents></a2-transclusion-contents>
</a1-transclude>
418
Injecting Across Frameworks
Simple Angular 2 component that will have an Angular 1.x service injected into it:
@Component({
selector: 'a2-using-a1-service',
template: `<p>{{ message }}</p>`
})
export class A2UsingA1Service {
message = '';
constructor(@Inject('a1UpgradeService') a1UpgradeService:A1UpgradeService) {
this.message = a1UpgradeService.data;
}
}
419
Injecting Across Frameworks
Angular 2.x services can be downgraded and injected into Angular 1. In normal operation,
Angular 2.x services would be bootstrapped with the application, but because of ng-upgrade
being a hybrid mode, this is not the case. The upgrade adapter comes with an addProvider
method that must be used in the interim.
@Injectable()
export class A2DowngradeService {
fetchData() {
return 'some data';
}
}
Since Angular 2 is bootstrapped with the upgrade adapter, there is no place to register
Angular 2 services. Fortunately the upgrade adapter's addProvider method can do this:
upgradeAdapter.addProvider(Phones);
420
Injecting Across Frameworks
class A1UsingA2 {
message: string;
constructor(private a2DowngradeService: A2DowngradeService) {
this.message = this.a2DowngradeService.fetchData();
}
}
421
Project Setup
Project Setup
Proper tooling and setup is good for any project, but it's especially important for Angular due
to all of the pieces that are involved. We've decided to use webpack, a powerful tool that
attempts to handle our complex integrations. Due to the number of parts of our project that
webpack touches, it's important to go over the configuration to get a good understanding of
what gets generated client-side.
422
Webpack
Webpack
A modern JavaScript web application includes a lot of different packages and dependencies,
and it's important to have something that makes sense of it all in a simple way.
Angular takes the approach of breaking your application apart into many different
components, each of which can have several files. Separating application logic this way is
good for the programmer, but can detract from user experience since doing this can increase
page loading time. HTTP2 aims to solve this problem in one way, but until more is known
about its effects we will want to bundle different parts of our application together and
compress it.
Our platform, the browser, must continue to provide backwards compatibility for all existing
code and this necessitates slow movement of additions to the base functionality of
HTML/CSS/JS. The community has created different tools that transform their preferred
syntax/feature set to what the browser supports to avoid binding themselves to the
constraints of the web platform. This is especially evident in Angular applications, where
TypeScript is used heavily. Although we don't do this in our course, projects may also involve
different CSS preprocessors (sass, stylus) or templating engines (jade, Mustache, EJS) that
must be integrated.
Webpack solves these problems by providing a common interface to integrate all of these
tools and that allows us to streamline our workflow and avoid complexity.
423
Installation and Usage
Installation
The easiest way to include webpack and its plugins is through NPM and save it to your
devDependencies :
Bundle
The core concept of webpack is the bundle. A bundle is simply a collection of modules,
where we define the boundaries for how they are separated. In this project, we have two
bundles:
In webpack, bundles are configured through entry points. Webpack goes through each entry
point one by one. It maps out a dependency graph by going through each module's
references. All the dependencies that it encounters are then packaged into that bundle.
Packages installed through NPM are referenced using CommonJS module resolution. In a
JavaScript file, this would look like:
or TypeScript/ES6 file:
We will use those string values as the module names we pass to webpack.
Let's look at the entry points we have defined in our sample app:
424
Installation and Usage
{
...
entry: {
app: './src/index.ts',
vendor: [
'@angular/core',
'@angular/compiler',
'@angular/common',
'@angular/http',
'@angular/platform-browser',
'@angular/platform-browser-dynamic',
'@angular/router',
'es6-shim',
'redux',
'redux-thunk',
'redux-logger',
'reflect-metadata',
'ng2-redux',
'zone.js',
]
}
...
}
The entry point for app , ./src/index.ts , is the base file of our Angular application. If we've
defined the dependencies of each module correctly, those references should connect all the
parts of our application from here. The entry point for vendor is a list of modules that we
need for our application code to work correctly. Even if these files are referenced by some
module in our app bundle, we want to separate these resources in a bundle just for third
party code.
Output Configuration
In most cases we don't just want to configure how webpack generates bundles - we also
want to configure how those bundles are output.
Often, we will want to re-route where files are saved. For example into a bin or dist
folder. This is because we want to optimize our builds for production.
Webpack transforms the code when bundling our modules and outputting them. We
want to have a way of connecting the code that's been generated by webpack and the
code that we've written.
Server routes can be configured in many different ways. We probably want some way of
configuring webpack to take our server routing setup into consideration.
425
Installation and Usage
All of these configuration options are handled by the config's output property. Let's look at
how we've set up our config to address these issues:
{
...
output: {
path: path.resolve(__dirname, 'dist'),
filename: '[name].[hash].js',
publicPath: "/",
sourceMapFilename: '[name].[hash].js.map'
}
...
}
Some options have words wrapped in square brackets. Webpack has the ability to
parse parameters for these properties, with each property having a different set of
parameters available for substitution. Here, we're using name (the name of the bundle)
and hash (a hash value of the bundle's content).
To save bundled files in a different folder, we use the path property. Here, path tells
webpack that all of the output files must be saved to path.resolve(__dirname, 'dist') . In
our case, we save each bundle into a separate file. The name of this file is specified by the
filename property.
Linking these bundled files and the files we've actually coded is done using what's known as
source maps. There are different ways to configure source maps. What we want is to save
these source maps in a separate file specified by the sourceMapFilename property. The way
the server accesses the files might not directly follow the filesystem tree. For us, we want to
use the files saved under dist as the root folder for our server. To let webpack know this,
we've set the publicPath property to / .
426
Loaders
Loaders
TypeScript isn't core JavaScript so webpack needs a bit of extra help to parse the .ts files.
It does this through the use of loaders. Loaders are a way of configuring how webpack
transforms the outputs of specific files in our bundles. Our ts-loader package is handling
this transformation for TypeScript files.
Inline
Loaders can be configured inline when requiring/importing a module:
The loader is specified by using the ! character to separate the module reference and the
loader that it will be run through. More than one loader can be used and those are separated
with ! in the same way. Loaders are executed right to left.
Be careful when configuring loaders this way it couples implementation details of different
stages of your application together so it might not be the right choice in a lot of cases.
Webpack Config
The preferred method is to configure loaders through the webpack.config.js file. For
example, the TypeScript loader task will look something like this:
{
test: /\.ts$/,
loader: 'ts-loader',
exclude: /node_modules/
}
427
Loaders
This runs the typescript compiler which respects our configuration settings as specified
above. We want to be able to handle other files and not just TypeScript files, so we need to
specify a list of loaders. This is done by creating an array of tasks.
Tasks specified in this array are chained. If a file matches multiple conditions, it will be
processed using each task in order.
{
...
module: {
rules: [
{ test: /\.ts$/, loader: 'tslint' },
{ test: /\.ts$/, loader: 'ts', exclude: /node_modules/ },
{ test: /\.html$/, loader: 'raw' },
{ test: /\.css$/, loader: 'style!css?sourceMap' },
{ test: /\.svg/, loader: 'url' },
{ test: /\.eot/, loader: 'url' },
{ test: /\.woff/, loader: 'url' },
{ test: /\.woff2/, loader: 'url' },
{ test: /\.ttf/, loader: 'url' },
],
noParse: [ /zone\.js\/dist\/.+/, /angular2\/bundles\/.+/ ]
}
...
}
test - The file path must match this condition to be handled. This is commonly used to
test file extensions eg. /\.ts$/ .
loader - The loaders that will be used to transform the input. This follows the syntax
specified above.
exclude - The file path must not match this condition to be handled. This is commonly
used to exclude file folders, e.g. /node_modules/ .
include - The file path must match this condition to be handled. This is commonly used
to include file folders. eg. path.resolve(__dirname, 'app/src') .
Pre-Loaders
The preLoaders array works just like the loaders array only it is a separate task chain that is
executed before the loaders task chain.
428
Loaders
Webpack also allows us to load non JavaScript assets such as: CSS, SVG, font files, etc. In
order to attach these assets to our bundle we must require/import them within our app
modules. For example:
import './styles/style.css';
// or
url-loader - returns a base64 encoded data URL if the file size is under a certain
threshold, otherwise it just returns the file.
style-loader - injects a style tag with the bundled CSS in the <head> tag.
429
Plugins
Plugins
Plugins allow us to inject custom build steps during the bundling process.
A commonly used plugin is the html-webpack-plugin . This allows us to generate HTML files
required for production. For example it can be used to inject script tags for the output
bundles.
new HtmlWebpackPlugin({
template: './src/index.html',
inject: 'body',
minify: false
});
430
Summary
Summary
When we put everything together, our complete webpack.config.js file looks something like
this:
'use strict';
const basePlugins = [
new webpack.optimize.CommonsChunkPlugin('vendor', '[name].[hash].bundle.js'),
new HtmlWebpackPlugin({
template: './src/index.html',
inject: 'body',
minify: false
})
];
const envPlugins = {
production: [
new webpack.optimize.UglifyJsPlugin({
compress: {
warnings: false
}
})
],
development: []
};
module.exports = {
entry: {
app: './src/index.ts',
vendor: [
'@angular/core',
'@angular/compiler',
'@angular/common',
'@angular/http',
'@angular/platform-browser',
'@angular/platform-browser-dynamic',
'@angular/router',
'es6-shim',
'redux',
'redux-thunk',
'redux-logger',
431
Summary
'reflect-metadata',
'ng2-redux',
'zone.js',
]
},
output: {
path: path.resolve(__dirname, 'dist'),
filename: '[name].[hash].js',
publicPath: "/",
sourceMapFilename: '[name].[hash].js.map'
},
devtool: 'source-map',
resolve: {
extensions: ['.webpack.js', '.web.js', '.ts', '.js']
},
plugins: plugins,
module: {
rules: [
{ test: /\.ts$/, loader: 'tslint' },
{ test: /\.ts$/, loader: 'ts', exclude: /node_modules/ },
{ test: /\.html$/, loader: 'raw' },
{ test: /\.css$/, loader: 'style!css?sourceMap' },
{ test: /\.svg/, loader: 'url' },
{ test: /\.eot/, loader: 'url' },
{ test: /\.woff/, loader: 'url' },
{ test: /\.woff2/, loader: 'url' },
{ test: /\.ttf/, loader: 'url' },
],
noParse: [ /zone\.js\/dist\/.+/, /angular2\/bundles\/.+/ ]
}
}
Going Further
Webpack also does things like hot code reloading and code optimization which we haven't
covered. For more information you can check out the official documentation. The source is
also available on Github.
432
NPM Scripts Integration
We rely on these scripts to manage most of our project tasks and webpack fits in as well.
The scripts are defined in the scripts property of the package.json file. For example:
...
scripts: {
"clean": "rimraf dist",
"prebuild": "npm run clean",
"build": "NODE_ENV=production webpack",
}
...
NPM allows pre and post task binding by prepending the word pre or post respectively to
the task name. Here, our prebuild task is executed before our build task.
To invoke the build script we run the command npm run build :
4. The build task is executed. This sets the NODE_ENV environment variable to
production and starts the webpack bundling process.
433
Angular CLI
Angular CLI
With all of the new features Angular takes advantage of, like static typing, decorators and
ES6 module resolution, comes the added cost of setup and maintenance. Spending a lot of
time with different build setups and configuring all of the different tools used to serve a
modern JavaScript application can really take a lot of time and drain productivity by not
being able to actually work on the app itself.
Seeing the popularity of ember-cli, Angular decided they would provide their own CLI to
solve this problem. Angular CLI is geared to be the tool used to create and manage your
Angular app. It provides the ability to:
The Angular CLI currently only generates scaffolding in TypeScript, with other dialects
to come later.
434
Setup
Setup
Prerequisites
Angular CLI is currently only distributed through npm and requires Node version 4 or greater.
Installation
The Angular CLI can be installed with the following command:
npm install -g angular-cli
435
Creating a New App
436
Creating a New App
Application configuration is stored in different places, some located in the config folder, such
as test configuration, and some being stored in the project root such as linting information
and build information. The CLI stores application-specific files in the src folder and Angular-
specific code in the src/app folder. Files and folders generated by the CLI will follow the
official style guide.
437
Creating a New App
Warning: The CLI relies on some of the settings defined in the configuration files to be
able to execute the commands. Take care when modifying them, particularly the
package.json file.
The CLI has installed everything a basic Angular application needs to run properly. To make
sure everything has run and installed correctly we can run the server.
438
Serving the App
By default, ng serve serves the application locally on port 4200 ( http://localhost:4200 ) but
this can be changed by using a command line argument: ng serve --port=8080 .
439
Creating Components
Creating Components
The CLI can scaffold Angular components through the generate command. To create a
new component run:
ng generate component [component-name]
Executing the command creates a folder, [component-name], in the project's src/app path
or the current path the command is executed in if it's a child folder of the project. The folder
has the following:
440
Creating Routes
Creating Routes
The ng g route [route-name] command will spin up a new folder and route files for you.
At the time of writing this feature was temporarily disabled due to ongoing changes
happening with Angular routing.
441
Creating Other Things
This creates the entity at src/app/[entity-name].[entity].ts along with a spec file, or at the
current path if the command is executed in a child folder of the project. The CLI provides
blueprints for the following entities out of the box:
442
Testing
Testing
Apps generated by the CLI integrate automated tests. The CLI does this by using the Karma
test runner.
Unit Tests
To execute unit tests, run ng test . This will run all the tests that are matched by the Karma
configuration file at config/karma.conf.js . It's set to match all TypeScript files that end in
.spec.ts by default.
End-to-End Tests
End-to-end tests can be executed by running ng e2e . Before end-to-end tests can be
performed, the application must be served at some address. Angular CLI uses protractor. It
will attempt to access localhost:4200 by default; if another port is being used, you will have
to update the configuration settings located at config/protractor.conf.js .
443
Linting
Linting
To encourage coding best practices Angular CLI provides built-in linting. By default the app
will look at the project's tslint.json for configuration. Linting can be executed by running
the command ng lint .
444
CLI Command Overview
Linting
ng lint lints the code in your project using tslint. You can customize the rules for your
You can switch some of these to use your preferred tool by editing the scripts in
package.json .
Testing
ng test triggers a build and then runs the unit tests set up for your app using Karma. Use
the --watch option to rebuild and retest the app automatically whenever source files
change.
Build
ng build will build your app (and minify your code) and place it into the default output path,
dist/ .
Serve
ng serve builds and serves your app on a local server and will automatically rebuild on file
E2E
Once your app is served, you can run end-to-end tests using ng e2e . The CLI uses
Protractor for these tests.
445
CLI Command Overview
Deploy
ng deploy deploys to GitHub pages or Firebase.
446
Adding Third Party Libraries
447
Integrating an Existing App
Since the folder structure for an existing app might not follow the same format as one
created by the CLI, the init command has some configuration options.
--source-dir identifies the relative path to the source files (default = src)
--prefix identifies the path within the source dir that Angular application files reside
(default = app)
--style identifies the path where additional style files are located (default = css).
448
Accessibility in Angular
449
Why Make my Application Accessible?
Why Accessibility
While making websites accessible can lead to more time spent in development, there are
many reasons why you should be making your application accessible.
In addition to this, accessibility techniques such as semantic markup help search engines
understand the application better, leading to improved visibility.
Accessibility Laws
Countries around the world have different accessibility rules centered around compliance of
two main sets of guidelines: Web Content Accessibilities (WCAG) 2.0 and Section 508. Not
being in compliance of these rules exposes you to liability.
450
Key Concerns of Accessible Web Applications
451
Semantic Markup
Semantic Markup
@Component({
selector: 'ngc2-app'
template: `
<div class="header">
<div class="navigation">
<div class="item"><a [routerLink]="['']"><img src="https://angular.io/resource
s/images/logos/angular2/angular.svg" width="40"></a></div>
<div class="item"><a [routerLink]="['services']">Services</a></div>
<div class="item"><a [routerLink]="['process']">Process</a></div>
<div class="item"><a [routerLink]="['work']">Work</a></div>
</div>
</div>
<router-outlet class="page-content">
</router-outlet>
`,
})
View Example
While it might be obvious to someone reading the HTML or using the application what the
purpose of each element is, the class names don't have any semantic meaning for browsers
and screen readers. We can give them more information by using the proper HTML
elements instead.
452
Semantic Markup
@Component({
selector: 'ngc2-app',
template: `
<header>
<nav>
<ul>
<li><a [routerLink]="['']"><img src="https://angular.io/resources/images/log
os/angular2/angular.svg" width="40" alt="Angular logo"></a></li>
<li><a [routerLink]="['services']">Services</a></li>
<li><a [routerLink]="['process']">Process</a></li>
<li><a [routerLink]="['work']">Work</a></li>
</ul>
</nav>
</header>
<main aria-live="polite">
<router-outlet>
</router-outlet>
</main>
`
})
View Example
Here, we use the header element instead of a div , which lets the browser know that the
elements within provide information about the site as a whole rather than about the specific
page.
We replace another div with the nav element, which lets the browser know the elements
within are related to accessing different parts of the page or site.
We also nest router-outlet within a main element, which tells the browser that the
content loaded into the router outlet is the main content of the page.
There are a couple of new attributes on different elements as well to give the browser even
more information. The alt attribute has been added to the image to let the browser know
that it's a logo image. There's also an aria-live attribute on the main element.
This attribute is part of larger spec known as Accessible Rich Internet Applications (WAI-
ARIA) which we'll go over in detail. This is something that lets screen readers know that the
content within the main tag will be updated on the client-side after the page has loaded and
needs to be watched for updates.
453
Semantic Markup
The ARIA spec was created as a way for content authors a way to provide additional context
to the semantics of their application rather than just details on how to render the content.
This allows assistive technology to understand what's going on inside an application and
relay that information in a structured and streamlined format for users with disabilities.
One of the main concepts in the ARIA spec is the role. A role defines what the purpose of an
html element is within the context of that document or application. Roles are defined by
adding an attribute to an html element ie. role="main" or are defined by default depending
on the html element.
Some examples of roles are list, button or navigation which are the default roles of ul ,
button and nav respectively. Sometimes however, you may not want or be able to use the
standard html element to represent these objects in your application, for example, you may
want to create your own button component with it's own distinct logic. In this case you can
make use of the role attribute:
454
Semantic Markup
@Component({
selector: 'ngc2-notification-button',
template: `
<span>{{label}}</span>
`,
styles: [`
:host {
display: flex;
width: 80px;
height: 80px;
justify-content: center;
align-items: center;
background-color: yellow;
border-radius: 40px;
}
:host:hover {
cursor: pointer;
}
`]
})
export class NotificationButtonComponent {
@Input()
message = 'Alert!';
@Input()
label = 'Notify';
@HostListener('click', [])
notify() {
this.notification.notify(this.message)
}
}
View Example
This lets you create a component that has the same semantics as a button element to
screen readers and browsers, but now have the opportunity to fully control the styling of that
component as well as inject your own custom logic.
ARIA attributes
Some native HTML tags have attributes that providers extra context on what's being
displayed on the browser. For example, the img tag's alt attribute lets the reader know
what is being shown using a short description.
455
Semantic Markup
However, native tags don't cover all cases. This is where ARIA fits in. ARIA attributes can
provide context on what roles specific elements have in the application or on how elements
within the document relate to each other.
One example of this is modals. Native modals provided by different platforms such as web
browsers often have limited customization options, which can make for a poor experience.
This necessitates the creation of custom modals.
A modal component can be given the role of dialog or alertdialog to let the browser know
that that component is acting as a modal. The modal component template can use the ARIA
attributes aria-labelledby and aria-described to describe to readers what the title and
purpose of the modal is.
app.component.ts
@Component({
selector: 'ngc2-app',
template: `
<ngc2-notification-button
message="Hello!"
label="Greeting"
role="button">
</ngc2-notification-button>
<ngc2-modal
[title]="modal.title"
[description]="modal.description"
[visible]="modal.visible"
(close)="modal.close()">
</ngc2-modal>
`
})
export class AppComponent {
constructor(private modal: ModalService) { }
}
notification-button.component.ts
456
Semantic Markup
@Component({
selector: 'ngc2-modal',
template: `
<div
role="dialog"
aria-labelledby="modal-title"
aria-describedby="modal-description">
<div id="modal-title">{{title}}</div>
<p id="modal-description">{{description}}</p>
<button (click)="close.emit()">OK</button>
</div>
`
})
export class ModalComponent {
...
}
View Example
ARIA tags can enhance the accessibility of an application, but should by no means be the
only accessibility consideration. More information is available in the WAI-ARIA specification.
457
Keyboard Accessibility
Keyboard Accessibility
Keyboard accessibility is the ability of your application to be interacted with using just a
keyboard. The more streamlined the site can be used this way, the more keyboard
accessible it is. Keyboard accessibility is one of the largest aspects of web accessibility
since it targets:
Focus
Keyboard interaction is driven by something called focus. In web applications, only one
element on a document has focus at a time, and keypresses will activate whatever function
is bound to that element. The currently focused element can be accessed programmatically
through the document.activeElement DOM method.
Visually, an element with focus is represented by default with a glowing border around the
element:
This border can be styled with CSS using the outline property, but it should not be
removed. Elements can also be styled using the :focus psuedo-selector.
Tabbing
458
Keyboard Accessibility
The most common way of moving focus along the page is through the tab key. Elements
will be traversed in the order they appear in the document outline - so that order must be
carefully considered during development. By default, only links, buttons and form controls
can receive keyboard focus.
Whenever possible, developers should bind behaviour to elements that can natively receive
focus, such as using a button rather than a div . They should also adjust the source order
of elements to change the tab traversal order.
There may, however, be cases where you'll want to change the default behaviour or tab
order. This can be done through the tabindex attribute. The tabindex can be given the
values:
less than zero - to let readers know that an element should be focusable but not
keyboard accessible
0 - to let readers know that that element should be accessible by keyboard
greater than zero - to let readers know the order in which the focusable element should
be reached using the keyboard. Order is calculated from lowest to highest.
Altering tabindex should be done carefully, and must also be paired with keypress support
for space and enter .
Transitions
The majority of transitions that happen in an Angular application will not involve a page
reload. This means that developers will need to carefully manage what happens to focus in
these cases.
It's important that if some action involves a transition away from the natural page flow, then
focus should be handled as well.
459
Keyboard Accessibility
@Component({
selector: 'ngc2-modal',
template: `
<div
role="dialog"
aria-labelledby="modal-title"
aria-describedby="modal-description">
<div id="modal-title">{{title}}</div>
<p id="modal-description">{{description}}</p>
<button (click)="close.emit()">OK</button>
</div>
`,
})
export class ModalComponent {
constructor(private modal: ModalService, private element: ElementRef) { }
ngOnInit() {
this.modal.visible$.subscribe(visible => {
if(visible) {
setTimeout(() => {
this.element.nativeElement.querySelector('button').focus();
}, 0);
}
})
}
}
View Example
In this example, we see that when the modal becomes visible, the OK button immediately
receives focus. This streamlines the experience for keyboard users or screen readers to
match the experience given to mouse users or those without screen readers.
460
Visual Assistance
Visual Assistance
One large category of disability is visual impairment. This includes not just the blind, but
those who are color blind or partially sighted, and require some additional consideration.
Color Contrast
When choosing colors for text or elements on a website, the contrast between them needs
to be considered. For WCAG 2.0 AA, this means that the contrast ratio for text or visual
representations of text needs to be at least 4.5:1.
There are tools online to measure the contrast ratio such as this color contrast checker from
WebAIM or be checked with using automation tests.
Visual Information
Color can help a user's understanding of information, but it should never be the only way to
convey information to a user. For example, a user with red/green color-blindness may have
trouble discerning at a glance if an alert is informing them of success or failure.
Always be sure that color is not the only way information is being conveyed to the user.
Audiovisual Media
Audiovisual elements in the application such as video, sound effects or audio (ie. podcasts)
need related textual representations such as transcripts, captions or descriptions. They also
should never auto-play and playback controls should be provided to the user.
461
Testing for Accessibility
There are many different concerns to consider when testing your application for accessibility.
The following questions can guide your accessibility testing and provide concrete items for
evaluation:
Is my Application Readable?
Is my Application Predictable?
Is my Application Navigable?
One excellent method for covering the bases of an accessible application is to test with
screen readers.
462
Is my Application Readable?
Is my Application Readable?
Users should be able to read and understand the information presented by your application.
Your application should also be flexible enough to meet your user's reading needs. Check in
particular:
Can the page be resized to 200% in the browser and still be usable?
Are text sizes appropriate across variable device widths?
Can the page still be read if the user is overriding your fonts with their own? (Try testing
this using the Chrome addon OpenDyslexic)
Does the text need to be adjusted for colour or weight to provide adequate contrast?
(Try your most used fonts in a contrast checker)
463
Is my Application Predictable?
Is my Application Predictable?
Users should be able to reasonably anticipate how an application behaves, and they should
remain in control of their experience at all times. Check for the following:
Has auto-play been turned off on all sliders, video and audio? Are playback controls
available?
Will the user be warned if a context switch occurs (e.g. a new window opening)?
Can interruptions (such as alerts or page updates) be postponed or suppressed by the
user?
Does the user have enough time to read alerts? Does the user's screen reader have
enough time?
464
Is my Application Navigable?
Is my Application Navigable?
One of the key accessibility features for any application is keyboard navigability. Because
many forms of assistive technology rely on keyboard controls exclusively, testing for
keyboard support is a good thing to prioritize. Check in particular:
465
Testing with Screen Readers
To test with a screen reader, you will need to use a screen reading program and navigate
your page using keyboard commands specific to that program. When testing with a screen
reader, do not rely on Chrome. Most screen reader users do not use Chrome as their main
browser, and browser-specific differences will occur in testing. Internet Explorer or Firefox
are preferred.
VoiceOver can be turned on and off with the keyboard shortcut CMD + F5 and also through
the System Preferences menu. In the System Preferences menu, you can also adjust the
speed at which VoiceOver will read to you. While testing, it is helpful to set it to a higher
speed.
WebAIM's guide for testing with VoiceOver provides detailed usage instructions.
Once NVDA has been downloaded and installed, you can start it with the keyboard
command Ctrl + Alt + N .
WebAIM's guide for testing with NVDA provides detailed usage instructions.
466
Testing with Screen Readers
It is likely that problems will jump out at you when you start, but check in particular for the
following:
Image names are not read out by the screen reader; they have appropriate descriptive
text
Elements that are inaccessible to the screen reader are not necessary to the user's
understanding
Blocks of repeating text (e.g. menus) can be skipped
The page is read in the intended/visual order (not source order)
Forms can be navigated, completed and understood clearly
Validation errors can be understood clearly
The screen reader understands and reads toasts and alerts in a comprehensible way
Additional Notes
When testing with a screen reader, it is important to remember that you will not necessarily
have a 100% authentic experience due to difference in screen reading programs and user
proficiency. The most popular screen readers are not free, and though many developers use
Macs, most screen reader users will use Windows.
467
Additional Resources
Additional Resources
While this section goes over the key aspects of making an accessible website with respect
to Angular, it is not a comprehensive guide for everything related to web accessibility. For
more information, please visit one of the resources below:
WAI-ARIA Specification
Web Content Accessibility Guidelines (WCAG) 2.0
Section 508
WebAIM - Organization with the goal of providing accessibility information
The A11y Project - A community driven site to help make web accessibility easier
WCAG 2.0 checklists
Testing Resources
Web Content Accessibility Toolkit
Guide for Evaluating Accessibility
pa11y - Automated Accessibility Monitoring
468
Internationalization in Angular
469
What is the process like and how is involved?
Use an angular i18n tool to extract the messages into an industry standard translation
source file.
Provide the industry standard translation source files to a translator, who will translate
the files and give them back to you.
470
Marking text in our templates
We use the pipe ( | ) to seperate the description (left) and contextual meaning (right).
471
Extracting translation text using the Angular CLI
Once this is done in your templates, you will need to install the CLI and it's platform-server
peer dependency if you haven't already and then execute the ng-x18n command to
generate a translation file:
By default, an XLIFF file is created but you use can append --i18nFormat=xmb if you would
prefer the XMB format. The file created would be the file that you would share with
translators who would fill in the translations using an XLIFF file editor. Once the translations
are done, the translation files are returned back to you.
You can also specify the output folder with the --project or -p tag. This folder must exist
for it to work.
The above command will output a *.xmb file in the locale folder.
Running ng-xi18n will compile your code before extracting translation texts. It will output .js
and .metadata.json files in your src folders. It might be a good idea to ignore these files
when uploading your git repository.
472
How to import the completed translation files
473
Using the AoT Compiler
To pre-build a seperate application, you will have to ensure that you have the tools required
to setup AoT. Refer to the AoT cookbook for details on how to do this.
Once your ready, use the ngc compile command providing the compiler with the following 3
options:
For example, the French language command would look something like this:
474
Using the JiT Compiler
Here's how to boostrap the app with the translation providers for French. We're assuming
the translation file is messages.fr.xlf .
app/index.ts:
@NgModule({
imports: [
BrowserModule
],
declarations: [
Hello
],
bootstrap: [ Hello ]
})
export class AppModule {
}
platformBrowserDynamic().bootstrapModule(AppModule, {
providers: [
{ provide: TRANSLATIONS, useValue: translations },
{ provide: TRANSLATIONS_FORMAT, useValue: 'xlf' },
{ provide: LOCALE_ID, useValue: localeId }
]
});
475
Using the JiT Compiler
View Example
We're using SystemJS text plugin to import raw xlf files. We could alternately use webpack
and raw-loader to achieve the same effect. Better yet, we could make an http call based on
which language we're interested in, and asynchronously bootstrap the app once its loaded.
476
Glossary
Glossary
Decorators
@Component more
@Directive more
@HostListener more
@Inject more
@Injectable more
@Input more
@NgModule more
@Output more
@Pipe more
@ViewChild more
@ViewChildren more
477
Further Reading And Reference
Angular
Angular.io API Reference - Angular Reference Material with easy access to different
Angular items
Angular Style Guide - Opinions from the Angular team
Angular Module Github - Source code is written in readable TypeScript
Angular Material Github - Official repo for Angular implementation in material design
TypeScript
tsconfig options - information on how to configure the TypeScript compiler
TypeScript Playground - In-browser TypeScript editor with live reload
TypeScript Handbook
TypeScript Deep Dive - Additional learning material
478
Further Reading And Reference
Keeping up to date
Angular Weekly Notes
Angular blog - Includes blog posts for Angular 1.x
Angular Air - Angular podcast
Adventures in Angular - Angular podcast
Angular Changelog - Technical Changelog
Other
Webpack 2 Official Docs
479