2019-12-07 09:30:53 -05:00
# NgZone
2020-11-16 16:37:09 -05:00
A zone is an execution context that persists across async tasks. You can think of it as [thread-local storage ](https://en.wikipedia.org/wiki/Thread-local_storage ) for JavaScript VMs.
2019-12-07 09:30:53 -05:00
This guide describes how to use Angular's NgZone to automatically detect changes in the component to update HTML.
## Fundamentals of change detection
To understand the benefits of `NgZone` , it is important to have a clear grasp of what change detection is and how it works.
### Displaying and updating data in Angular
2020-09-17 12:39:51 -04:00
In Angular, you can display data by binding controls in an HTML template to the properties of an Angular component.
2019-12-07 09:30:53 -05:00
< code-example path = "displaying-data/src/app/app.component.1.ts" header = "src/app/app.component.ts" > < / code-example >
In addition, you can bind DOM events to a method of an Angular component. In such methods, you can also update a property of the Angular component, which updates the corresponding data displayed in the template.
< code-example path = "user-input/src/app/click-me.component.ts" region = "click-me-component" header = "src/app/click-me.component.ts" > < / code-example >
In both of the above examples, the component's code updates only the property of the component.
However, the HTML is also updated automatically.
This guide describes how and when Angular renders the HTML based on the data from the Angular component.
### Detecting changes with plain JavaScript
To clarify how changes are detected and values updated, consider the following code written in plain JavaScript.
```javascript
< html >
< div id = "dataDiv" > < / div >
2020-04-12 14:21:37 -04:00
< button id = "btn" > updateData< / button >
< canvas id = "canvas" > < / canvas >
2019-12-07 09:30:53 -05:00
< script >
let value = 'initialValue';
// initial rendering
detectChange();
function renderHTML() {
document.getElementById('dataDiv').innerText = value;
}
function detectChange() {
const currentValue = document.getElementById('dataDiv').innerText;
if (currentValue !== value) {
renderHTML();
}
}
2020-03-06 07:39:16 -05:00
// Example 1: update data inside button click event handler
2019-12-07 09:30:53 -05:00
document.getElementById('btn').addEventListener('click', () => {
// update value
value = 'button update value';
// call detectChange manually
detectChange();
});
2020-03-06 07:39:16 -05:00
// Example 2: HTTP Request
2019-12-07 09:30:53 -05:00
const xhr = new XMLHttpRequest();
xhr.addEventListener('load', function() {
// get response from server
value = this.responseText;
// call detectChange manually
detectChange();
});
xhr.open('GET', serverUrl);
xhr.send();
2020-03-06 07:39:16 -05:00
// Example 3: setTimeout
2019-12-07 09:30:53 -05:00
setTimeout(() => {
// update value inside setTimeout callback
value = 'timeout update value';
// call detectChange manually
detectChange();
}, 100);
2020-03-06 07:39:16 -05:00
// Example 4: Promise.then
Promise.resolve('promise resolved a value').then(v => {
2019-12-07 09:30:53 -05:00
// update value inside Promise thenCallback
value = v;
// call detectChange manually
detectChange();
}, 100);
2020-03-06 07:39:16 -05:00
// Example 5: some other asynchronous APIs
2019-12-07 09:30:53 -05:00
document.getElementById('canvas').toBlob(blob => {
// update value when blob data is created from the canvas
2020-03-06 07:39:16 -05:00
value = `value updated by canvas, size is ${blob.size}` ;
2019-12-07 09:30:53 -05:00
// call detectChange manually
detectChange();
});
< / script >
< / html >
```
After you update the data, you need to call `detectChange()` manually to check whether the data changed.
If the data changed, you render the HTML to reflect the updated data.
In Angular, this step is unnecessary. Whenever you update the data, your HTML is updated automatically.
### When apps update HTML
To understand how change detection works, first consider when the application needs to update the HTML. Typically, updates occur for one of the following reasons:
2020-09-17 12:39:51 -04:00
1. Component initialization. For example, when bootstrapping an Angular application, Angular loads the bootstrap component and triggers the [ApplicationRef.tick() ](api/core/ApplicationRef#tick ) to call change detection and View Rendering.
2019-12-07 09:30:53 -05:00
2020-09-17 12:39:51 -04:00
1. Event listener. The DOM event listener can update the data in an Angular component and also trigger change detection, as in the following example.
2019-12-07 09:30:53 -05:00
< code-example path = "user-input/src/app/click-me.component.ts" region = "click-me-component" header = "src/app/click-me.component.ts" > < / code-example >
docs: correct appearance of numbering (#39638)
Ordered list was appearing as 1,2,*1*,4,5,6 due to code block interrupting the flow.
This fixes the list to appear as 1,2,3,4,5,6.
PR Close #39638
2020-11-11 20:41:06 -05:00
3. HTTP Data Request. You can also get data from a server through an HTTP request. For example:
2019-12-07 09:30:53 -05:00
```typescript
@Component ({
selector: 'app-root',
template: '< div > {{data}}< / div > ';
})
export class AppComponent implements OnInit {
data = 'initial value';
2020-03-16 15:53:44 -04:00
serverUrl = 'SERVER_URL';
2019-12-07 09:30:53 -05:00
constructor(private httpClient: HttpClient) {}
ngOnInit() {
2020-03-16 15:53:44 -04:00
this.httpClient.get(this.serverUrl).subscribe(response => {
2019-12-07 09:30:53 -05:00
// user does not need to trigger change detection manually
2020-03-16 15:53:44 -04:00
this.data = response.data;
2019-12-07 09:30:53 -05:00
});
}
}
```
2020-03-06 07:39:16 -05:00
4. MacroTasks, such as `setTimeout()` or `setInterval()` . You can also update the data in the callback function of a `macroTask` such as `setTimeout()` . For example:
2019-12-07 09:30:53 -05:00
```typescript
@Component ({
selector: 'app-root',
template: '< div > {{data}}< / div > ';
})
export class AppComponent implements OnInit {
data = 'initial value';
ngOnInit() {
setTimeout(() => {
// user does not need to trigger change detection manually
2020-03-16 15:53:44 -04:00
this.data = 'value updated';
2019-12-07 09:30:53 -05:00
});
}
}
```
2020-03-06 07:39:16 -05:00
5. MicroTasks, such as `Promise.then()` . Other asynchronous APIs return a Promise object (such as `fetch` ), so the `then()` callback function can also update the data. For example:
2019-12-07 09:30:53 -05:00
```typescript
@Component ({
selector: 'app-root',
template: '< div > {{data}}< / div > ';
})
export class AppComponent implements OnInit {
data = 'initial value';
ngOnInit() {
Promise.resolve(1).then(v => {
// user does not need to trigger change detection manually
2020-03-16 15:53:44 -04:00
this.data = v;
2019-12-07 09:30:53 -05:00
});
}
}
```
2020-03-06 07:39:16 -05:00
6. Other async operations. In addition to `addEventListener()` , `setTimeout()` and `Promise.then()` , there are other operations that can update the data asynchronously. Some examples include `WebSocket.onmessage()` and `Canvas.toBlob()` .
2019-12-07 09:30:53 -05:00
The preceding list contains most common scenarios in which the application might change the data. Angular runs change detection whenever it detects that data could have changed.
2020-03-06 07:39:16 -05:00
The result of change detection is that the DOM is updated with new data. Angular detects the changes in different ways. For component initialization, Angular calls change detection explicitly. For [asynchronous operations ](https://developer.mozilla.org/en-US/docs/Learn/JavaScript/Asynchronous ), Angular uses a zone to detect changes in places where the data could have possibly mutated and it runs change detection automatically.
2019-12-07 09:30:53 -05:00
## Zones and execution contexts
2020-03-06 07:39:16 -05:00
A zone provides an execution context that persists across async tasks. [Execution Context ](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/this ) is an abstract concept that holds information about the environment within the current code being executed. Consider the following example:
2019-12-07 09:30:53 -05:00
```javascript
const callback = function() {
console.log('setTimeout callback context is', this);
}
2020-03-06 07:39:16 -05:00
const ctx1 = { name: 'ctx1' };
const ctx2 = { name: 'ctx2' };
2019-12-07 09:30:53 -05:00
const func = function() {
console.log('caller context is', this);
setTimeout(callback);
}
func.apply(ctx1);
func.apply(ctx2);
```
2020-03-06 07:39:16 -05:00
The value of `this` in the callback of `setTimeout()` might differ depending on when `setTimeout()` is called.
Thus, you can lose the context in asynchronous operations.
2019-12-07 09:30:53 -05:00
2020-03-16 15:53:44 -04:00
A zone provides a new zone context other than `this` , the zone context that persists across asynchronous operations.
2019-12-07 09:30:53 -05:00
In the following example, the new zone context is called `zoneThis` .
```javascript
zone.run(() => {
// now you are in a zone
expect(zoneThis).toBe(zone);
setTimeout(function() {
// the zoneThis context will be the same zone
// when the setTimeout is scheduled
expect(zoneThis).toBe(zone);
});
});
```
This new context, `zoneThis` , can be retrieved from the `setTimeout()` callback function, and this context is the same when the `setTimeout()` is scheduled.
To get the context, you can call [`Zone.current` ](https://github.com/angular/angular/blob/master/packages/zone.js/lib/zone.ts ).
2020-02-27 22:11:26 -05:00
## Zones and async lifecycle hooks
2019-12-07 09:30:53 -05:00
Zone.js can create contexts that persist across asynchronous operations as well as provide lifecycle hooks for asynchronous operations.
```javascript
const zone = Zone.current.fork({
name: 'zone',
onScheduleTask: function(delegate, curr, target, task) {
2020-03-06 07:39:16 -05:00
console.log('new task is scheduled:', task.type, task.source);
2019-12-07 09:30:53 -05:00
return delegate.scheduleTask(target, task);
},
onInvokeTask: function(delegate, curr, target, task, applyThis, applyArgs) {
2020-03-06 07:39:16 -05:00
console.log('task will be invoked:', task.type, task.source);
2019-12-07 09:30:53 -05:00
return delegate.invokeTask(target, task, applyThis, applyArgs);
},
onHasTask: function(delegate, curr, target, hasTaskState) {
2020-03-06 07:39:16 -05:00
console.log('task state changed in the zone:', hasTaskState);
2019-12-07 09:30:53 -05:00
return delegate.hasTask(target, hasTaskState);
},
onInvoke: function(delegate, curr, target, callback, applyThis, applyArgs) {
2020-03-06 07:39:16 -05:00
console.log('the callback will be invoked:', callback);
2019-12-07 09:30:53 -05:00
return delegate.invoke(target, callback, applyThis, applyArgs);
}
});
zone.run(() => {
setTimeout(() => {
console.log('timeout callback is invoked.');
});
});
```
The above example creates a zone with several hooks.
2020-03-06 07:39:16 -05:00
The `onXXXTask` hooks trigger when the status of the task changes.
The concept of a *Zone Task* is very similar to the JavaScript VM Task concept:
- `macroTask` : such as `setTimeout()`
- `microTask` : such as `Promise.then()`
- `eventTask` : such as `element.addEventListener()`
2019-12-07 09:30:53 -05:00
These hooks trigger under the following circumstances:
- `onScheduleTask` : triggers when a new asynchronous task is scheduled, such as when you call `setTimeout()` .
- `onInvokeTask` : triggers when an asynchronous task is about to execute, such as when the callback of `setTimeout()` is about to execute.
2020-03-06 07:39:16 -05:00
- `onHasTask` : triggers when the status of one kind of task inside a zone changes from stable to unstable or from unstable to stable. A status of "stable" means there are no tasks inside the zone, while "unstable" means a new task is scheduled in the zone.
2020-03-16 15:53:44 -04:00
- `onInvoke` : triggers when a synchronous function is going to execute in the zone.
2019-12-07 09:30:53 -05:00
2020-03-16 15:53:44 -04:00
With these hooks, `Zone` can monitor the status of all synchronous and asynchronous operations inside a zone.
2019-12-07 09:30:53 -05:00
2020-03-06 07:39:16 -05:00
The above example returns the following output:
2019-12-07 09:30:53 -05:00
```
2020-03-06 07:39:16 -05:00
the callback will be invoked: () => {
2019-12-07 09:30:53 -05:00
setTimeout(() => {
console.log('timeout callback is invoked.');
});
}
2020-03-06 07:39:16 -05:00
new task is scheduled: macroTask setTimeout
task state changed in the zone: { microTask: false,
2019-12-07 09:30:53 -05:00
macroTask: true,
eventTask: false,
change: 'macroTask' }
2020-03-06 07:39:16 -05:00
task will be invoked macroTask: setTimeout
2019-12-07 09:30:53 -05:00
timeout callback is invoked.
2020-03-06 07:39:16 -05:00
task state changed in the zone: { microTask: false,
2019-12-07 09:30:53 -05:00
macroTask: false,
eventTask: false,
change: 'macroTask' }
```
2020-03-06 07:39:16 -05:00
All of the functions of `Zone` are provided by a library called [Zone.js ](https://github.com/angular/angular/tree/master/packages/zone.js/README.md ).
2019-12-07 09:30:53 -05:00
This library implements those features by intercepting asynchronous APIs through monkey patching.
Monkey patching is a technique to add or modify the default behavior of a function at runtime without changing the source code.
## NgZone
While Zone.js can monitor all the states of synchronous and asynchronous operations, Angular additionally provides a service called NgZone.
2020-02-26 18:26:37 -05:00
This service creates a zone named `angular` to automatically trigger change detection when the following conditions are satisfied:
2019-12-07 09:30:53 -05:00
1. When a sync or async function is executed.
1. When there is no `microTask` scheduled.
2020-03-06 07:39:16 -05:00
### NgZone `run()` and `runOutsideOfAngular()`
2019-12-07 09:30:53 -05:00
2020-03-05 17:10:20 -05:00
`Zone` handles most asynchronous APIs such as `setTimeout()` , `Promise.then()` , and `addEventListener()` .
2019-12-07 09:30:53 -05:00
For the full list, see the [Zone Module document ](https://github.com/angular/angular/blob/master/packages/zone.js/MODULE.md ).
Therefore in those asynchronous APIs, you don't need to trigger change detection manually.
There are still some third party APIs that Zone does not handle.
2021-02-11 18:21:03 -05:00
In those cases, the `NgZone` service provides a [`run()` ](api/core/NgZone#run ) method that allows you to execute a function inside the Angular zone.
2019-12-07 09:30:53 -05:00
This function, and all asynchronous operations in that function, trigger change detection automatically at the correct time.
```typescript
export class AppComponent implements OnInit {
constructor(private ngZone: NgZone) {}
ngOnInit() {
2020-02-27 22:11:26 -05:00
// New async API is not handled by Zone, so you need to
2021-02-11 18:21:03 -05:00
// use ngZone.run() to make the asynchronous operation in the Angular zone
2020-02-27 22:11:26 -05:00
// and trigger change detection automatically.
2019-12-07 09:30:53 -05:00
this.ngZone.run(() => {
someNewAsyncAPI(() => {
2020-02-27 22:11:26 -05:00
// update the data of the component
2019-12-07 09:30:53 -05:00
});
});
}
}
```
2021-02-11 18:21:03 -05:00
By default, all asynchronous operations are inside the Angular zone, which triggers change detection automatically.
2019-12-07 09:30:53 -05:00
Another common case is when you don't want to trigger change detection.
2020-03-06 07:39:16 -05:00
In that situation, you can use another `NgZone` method: [`runOutsideAngular()` ](api/core/NgZone#runoutsideangular ).
2019-12-07 09:30:53 -05:00
```typescript
export class AppComponent implements OnInit {
constructor(private ngZone: NgZone) {}
ngOnInit() {
2020-02-27 22:11:26 -05:00
// You know no data will be updated,
// so you don't want to trigger change detection in this
// specified operation. Instead, call ngZone.runOutsideAngular()
2019-12-07 09:30:53 -05:00
this.ngZone.runOutsideAngular(() => {
setTimeout(() => {
2020-02-27 22:11:26 -05:00
// update component data
// but don't trigger change detection.
2019-12-07 09:30:53 -05:00
});
});
}
}
```
2020-02-27 22:11:26 -05:00
### Setting up Zone.js
2019-12-07 09:30:53 -05:00
2020-03-06 07:39:16 -05:00
To make Zone.js available in Angular, you need to import the `zone.js` package.
2019-12-07 09:30:53 -05:00
If you are using the Angular CLI, this step is done automatically, and you will see the following line in the `src/polyfills.ts` :
```typescript
/***************************************************************************************************
* Zone JS is required by default for Angular itself.
*/
import 'zone.js/dist/zone'; // Included with Angular CLI.
```
Before importing the `zone.js` package, you can set the following configurations:
- You can disable some asynchronous API monkey patching for better performance.
For example, you can disable the `requestAnimationFrame()` monkey patch, so the callback of `requestAnimationFrame()` will not trigger change detection.
This is useful if, in your application, the callback of the `requestAnimationFrame()` will not update any data.
2021-02-11 18:21:03 -05:00
- You can specify that certain DOM events do not run inside the Angular zone; for example, to prevent a `mousemove` or `scroll` event to trigger change detection.
2019-12-07 09:30:53 -05:00
There are several other settings you can change.
To make these changes, you need to create a `zone-flags.ts` file, such as the following.
```typescript
2020-03-06 07:39:16 -05:00
// disable patching requestAnimationFrame
(window as any).__Zone_disable_requestAnimationFrame = true;
// disable patching specified eventNames
(window as any).__zone_symbol__UNPATCHED_EVENTS = ['scroll', 'mousemove'];
2019-12-07 09:30:53 -05:00
```
2020-03-06 07:39:16 -05:00
Next, import `zone-flags` before you import `zone.js` in the `polyfills.ts` :
2019-12-07 09:30:53 -05:00
```typescript
/***************************************************************************************************
* Zone JS is required by default for Angular.
*/
import `./zone-flags` ;
import 'zone.js/dist/zone'; // Included with Angular CLI.
```
2020-03-06 07:39:16 -05:00
For more information about what you can configure, see the [Zone.js ](https://github.com/angular/angular/tree/master/packages/zone.js ) documentation.
2019-12-07 09:30:53 -05:00
### NoopZone
`Zone` helps Angular know when to trigger change detection and let the developers focus on the application development.
2020-03-06 07:39:16 -05:00
By default, `Zone` is loaded and works without additional configuration. However, you don't necessarily have to use `Zone` to make Angular work. Instead, you can opt to trigger change detection on your own.
2019-12-07 09:30:53 -05:00
< div class = "alert is-helpful" >
< h4 > Disabling < code > Zone< / code > < / h4 >
**If you disable `Zone` , you will need to trigger all change detection at the correct timing yourself, which requires comprehensive knowledge of change detection**.
< / div >
2020-03-06 07:39:16 -05:00
To remove Zone.js, make the following changes.
2019-12-07 09:30:53 -05:00
2020-03-06 07:39:16 -05:00
1. Remove the `zone.js` import from `polyfills.ts` :
2019-12-07 09:30:53 -05:00
```typescript
/***************************************************************************************************
* Zone JS is required by default for Angular itself.
*/
// import 'zone.js/dist/zone'; // Included with Angular CLI.
```
2020-03-06 07:39:16 -05:00
2. Bootstrap Angular with the `noop` zone in `src/main.ts` :
2019-12-07 09:30:53 -05:00
```typescript
2020-03-06 07:39:16 -05:00
platformBrowserDynamic().bootstrapModule(AppModule, { ngZone: 'noop' })
2019-12-07 09:30:53 -05:00
.catch(err => console.error(err));
```
