Angular2: *ngFor does not update when array is updated

39

votes

I have an array of objects (let's call it arr). In one of my component's inputs in the (change) method I modify one of these object's attribute, but in the view (*ngFor) nothing changes. I read that Angular2 change detection doesn't check the contents of arrays or object, so I tried these:

this.arr = this.arr.slice();

and

this.arr = [...this.arr];

But the view doesn't change, it still shows the old attribute. In the (change) method with console.log() I got the correct array. Weird, but this one works: this.arr = []; I tried NgZone and markForCheck() too.

angularangular2-changedetection

25

votes

You could also use the trackBy option in your *ngFor expression, providing a unique ID for every item inside the array. This does make you 100% responsible for change detection, so update this (unique) property every time the item in the array changes. Angular will then only re-render the list if any item inside your array has been given a different trackBy property:

*ngFor="let item of (itemList$ | async); trackBy: trackItem"

or:

*ngFor="let item of itemList; trackBy: trackItem"

where:

trackItem is a public method in your component:

public trackItem (index: number, item: Item) {
  return item.trackId;
}

21

votes

Since you mentioned that you already tried markForCheck(), you should try detectChanges instead (that just what worked for me and markForCheck did not work). For those that need the steps:

Add ChangeDetectorRef to your imports:

import { Component, OnInit, ChangeDetectorRef } from '@angular/core';

Add ChangeDetectorRef to your constructor:

constructor(
    private changeDetection: ChangeDetectorRef
  ) { }

Then on the next line after you update the array:

this.changeDetection.detectChanges();

5

votes

late to the game but creating a deep clone using lodash worked for me

this.arr = cloneDeep(this.arr);

https://lodash.com/docs/4.17.15#cloneDeep

4

votes

Check if your component is configured with changeDetection:cHangeDetectionStrategy.OnPush, if you are going this then after updation of array you have to call changeDetectorRef.markForCheck()
You can also implement onChange lifecycle hook and change values of array inside this function.

4

votes

I solved this error by adding a changDetection directive on @component as follows

    @Component({
      selector: 'app-page',
      templateUrl: './page.component.html',
      styleUrls: ['./page.component.scss'],
      changeDetection: ChangeDetectionStrategy.Default
    })

You also need to import it

import { Component, OnInit, ChangeDetectionStrategy } from '@angular/core';

There are two strategies onPush and Default

The onPush uses the CheckOnce strategy, meaning that automatic change detection is deactivated until reactivated by setting the strategy to Default (CheckAlways). Change detection can still be explictly invoked.

while the Default uses the CheckAlways strategy, in which change detection is automatic until explicitly deactivated.

Source Docs

3

votes

Try creating a deep copy by doing

this.arr = Object.assign({}, NEW_VALUE);

0

votes

Incase anyone else runs into my situation, make sure that the component that is updating is the same copy as the one being rendered.

I was using @ViewChild(MyComponent, { static: true }) private test: MyComponent to pass data to the component with the ngfor. (In my case that ended up locking onto another copy I didn't know about)

I was able to fix it by adding the attribute #mycomp to my component tag in the html and changing the above to @ViewChild('mycomp', { static: true }) private test: MyComponent

0

votes

Not a perfect solution but works:

const temp = this.arr;
this.arr = [];
temp.push(obj); // or any other changes
this.arr = temp;

I really don't like importing new stuff because of increasing bundle size and in some cases can cause memory problems so I handle it this way.

0

votes

If you reassign an array the change detection won't notice the change. So instead of reassigning an array like this.arr = ... change the array directly. This could look like this:

this.arr.splice(0); // empty the array, without reassigning it
this.arr.push(...); // push new items

That way you don't need to call the change detection manually.

Example

Let's say a have a list for a table which can be filtered (the user can i.e. search). So I will have a list which contains all possible items, and a filteredList which is used in the UI and shown to the user.

// in ngOnInit I load the full list
this.list = this.myService.getList();
this.filteredList = [...this.list] // Since I will change the filtered list directly instead of reassigning it, I need to make a copy to not affect the original full list.

// then in a filter function, i.e. filterList()
this.filteredList.splice(0);
this.filteredList.push([...this.list.filter(/* ... */)]); // Again I need to push copies

0

votes

Any time I need to deal with *ngFor that needs change detection I prefer using behaviorSubject and async pipe. (I know this is a longer solution. Using behavior subject makes it easy to work with change detection)

array$ = new BehaviorSubject([]);//Declare your array

When you need to update your array

array$.next(newArray)://Pass in new array data

if you want to read your array value in the .ts file use this

array$.getValue()

in your .HTML file

*ngFor='let obj of (array$ | async)'

Angular2: *ngFor does not update when array is updated

10 Answers

Example