|
| 1 | +# Skipping component subtrees |
| 2 | + |
| 3 | +JavaScript, by default, uses mutable data structures that you can reference from multiple different components. Angular runs change detection over your entire component tree to make sure that the most up-to-date state of your data structures is reflected in the DOM. |
| 4 | + |
| 5 | +Change detection is sufficiently fast for most applications. However, when an application has an especially large component tree, running change detection across the whole application can cause performance issues. You can address this by configuring change detection to only run on a subset of the component tree. |
| 6 | + |
| 7 | +If you are confident that a part of the application is not affected by a state change, you can use [OnPush](/api/core/ChangeDetectionStrategy) to skip change detection in an entire component subtree. |
| 8 | + |
| 9 | +## Using `OnPush` |
| 10 | + |
| 11 | +OnPush change detection instructs Angular to run change detection for a component subtree **only** when: |
| 12 | + |
| 13 | +* The root component of the subtree receives new inputs as the result of a template binding. Angular compares the current and past value of the input with `==`. |
| 14 | +* Angular handles an event _(for example using event binding, output binding, or `@HostListener` )_ in the subtree's root component or any of its children whether they are using OnPush change detection or not. |
| 15 | + |
| 16 | +You can set the change detection strategy of a component to `OnPush` in the `@Component` decorator: |
| 17 | + |
| 18 | +```ts |
| 19 | +import { ChangeDetectionStrategy, Component } from '@angular/core'; |
| 20 | +@Component({ |
| 21 | + changeDetection: ChangeDetectionStrategy.OnPush, |
| 22 | +}) |
| 23 | +export class MyComponent {} |
| 24 | +``` |
| 25 | + |
| 26 | +## Common change detection scenarios |
| 27 | + |
| 28 | +This section examines several common change detection scenarios to illustrate Angular's behavior. |
| 29 | + |
| 30 | +### An event is handled by a component with default change detection |
| 31 | + |
| 32 | +If Angular handles an event within a component without `OnPush` strategy, the framework executes change detection on the entire component tree. Angular will skip descendant component subtrees with roots using `OnPush`, which have not received new inputs. |
| 33 | + |
| 34 | +As an example, if we set the change detection strategy of `MainComponent` to `OnPush` and the user interacts with a component outside the subtree with root `MainComponent`, Angular will check all the pink components from the diagram below (`AppComponent`, `HeaderComponent`, `SearchComponent`, `ButtonComponent`) unless `MainComponent` receives new inputs: |
| 35 | + |
| 36 | +```mermaid |
| 37 | +graph TD; |
| 38 | + app[AppComponent] --- header[HeaderComponent]; |
| 39 | + app --- main["MainComponent (OnPush)"]; |
| 40 | + header --- search[SearchComponent]; |
| 41 | + header --- button[ButtonComponent]; |
| 42 | + main --- login["LoginComponent (OnPush)"]; |
| 43 | + main --- details[DetailsComponent]; |
| 44 | + event>Event] --- search |
| 45 | +
|
| 46 | +class app checkedNode |
| 47 | +class header checkedNode |
| 48 | +class button checkedNode |
| 49 | +class search checkedNode |
| 50 | +class event eventNode |
| 51 | +``` |
| 52 | + |
| 53 | +## An event is handled by a component with OnPush |
| 54 | + |
| 55 | +If Angular handles an event within a component with OnPush strategy, the framework will execute change detection within the entire component tree. Angular will ignore component subtrees with roots using OnPush, which have not received new inputs and are outside the component which handled the event. |
| 56 | + |
| 57 | +As an example, if Angular handles an event within `MainComponent`, the framework will run change detection in the entire component tree. Angular will ignore the subtree with root `LoginComponent` because it has `OnPush` and the event happened outside of its scope. |
| 58 | + |
| 59 | +```mermaid |
| 60 | +graph TD; |
| 61 | + app[AppComponent] --- header[HeaderComponent]; |
| 62 | + app --- main["MainComponent (OnPush)"]; |
| 63 | + header --- search[SearchComponent]; |
| 64 | + header --- button[ButtonComponent]; |
| 65 | + main --- login["LoginComponent (OnPush)"]; |
| 66 | + main --- details[DetailsComponent]; |
| 67 | + event>Event] --- main |
| 68 | +
|
| 69 | +class app checkedNode |
| 70 | +class header checkedNode |
| 71 | +class button checkedNode |
| 72 | +class search checkedNode |
| 73 | +class main checkedNode |
| 74 | +class details checkedNode |
| 75 | +class event eventNode |
| 76 | +``` |
| 77 | + |
| 78 | +## An event is handled by a descendant of a component with OnPush |
| 79 | + |
| 80 | +If Angular handles an event in a component with OnPush, the framework will execute change detection in the entire component tree, including the component’s ancestors. |
| 81 | + |
| 82 | +As an example, in the diagram below, Angular handles an event in `LoginComponent` which uses OnPush. Angular will invoke change detection in the entire component subtree including `MainComponent` (`LoginComponent`’s parent), even though `MainComponent` has `OnPush` as well. Angular checks `MainComponent` as well because `LoginComponent` is part of its view. |
| 83 | + |
| 84 | +```mermaid |
| 85 | +graph TD; |
| 86 | + app[AppComponent] --- header[HeaderComponent]; |
| 87 | + app --- main["MainComponent (OnPush)"]; |
| 88 | + header --- search[SearchComponent]; |
| 89 | + header --- button[ButtonComponent]; |
| 90 | + main --- login["LoginComponent (OnPush)"]; |
| 91 | + main --- details[DetailsComponent]; |
| 92 | + event>Event] --- login |
| 93 | +
|
| 94 | +class app checkedNode |
| 95 | +class header checkedNode |
| 96 | +class button checkedNode |
| 97 | +class search checkedNode |
| 98 | +class login checkedNode |
| 99 | +class main checkedNode |
| 100 | +class details checkedNode |
| 101 | +class event eventNode |
| 102 | +``` |
| 103 | + |
| 104 | +## New inputs to component with OnPush |
| 105 | + |
| 106 | +Angular will run change detection within a child component with `OnPush` when setting an input property as result of a template binding. |
| 107 | + |
| 108 | +For example, in the diagram below, `AppComponent` passes a new input to `MainComponent`, which has `OnPush`. Angular will run change detection in `MainComponent` but will not run change detection in `LoginComponent`, which also has `OnPush`, unless it receives new inputs as well. |
| 109 | + |
| 110 | +```mermaid |
| 111 | +graph TD; |
| 112 | + app[AppComponent] --- header[HeaderComponent]; |
| 113 | + app --- main["MainComponent (OnPush)"]; |
| 114 | + header --- search[SearchComponent]; |
| 115 | + header --- button[ButtonComponent]; |
| 116 | + main --- login["LoginComponent (OnPush)"]; |
| 117 | + main --- details[DetailsComponent]; |
| 118 | + event>Parent passes new input to MainComponent] |
| 119 | +
|
| 120 | +class app checkedNode |
| 121 | +class header checkedNode |
| 122 | +class button checkedNode |
| 123 | +class search checkedNode |
| 124 | +class main checkedNode |
| 125 | +class details checkedNode |
| 126 | +class event eventNode |
| 127 | +``` |
| 128 | + |
| 129 | +## Edge cases |
| 130 | + |
| 131 | +* **Modifying input properties in TypeScript code**. When you use an API like `@ViewChild` or `@ContentChild` to get a reference to a component in TypeScript and manually modify an `@Input` property, Angular will not automatically run change detection for OnPush components. If you need Angular to run change detection, you can inject `ChangeDetectorRef` in your component and call `changeDetectorRef.markForCheck()` to tell Angular to schedule a change detection. |
| 132 | +* **Modifying object references**. In case an input receives a mutable object as value and you modify the object but preserve the reference, Angular will not invoke change detection. That’s the expected behavior because the previous and the current value of the input point to the same reference. |
0 commit comments