Help Angular by taking a 1 minute survey!Go to surveyHome
API > @angular/core

ViewChildren

Configures a view query.

See more...

Description

You can use ViewChildren to get the QueryList of elements or directives from the view DOM. Any time a child element is added, removed, or moved, the query list will be updated, and the changes observable of the query list will emit a new value.

View queries are set before the ngAfterViewInit callback is called.

Metadata Properties:

  • selector - the directive type or the name used for querying.
  • read - read a different token from the queried elements.

Options

Usage notes

Example

import {AfterViewInit, Component, Directive, QueryList, ViewChildren} from '@angular/core'; @Directive({selector: 'child-directive'}) class ChildDirective { } @Component({selector: 'someCmp', templateUrl: 'someCmp.html'}) class SomeCmp implements AfterViewInit { // TODO(issue/24571): remove '!'. @ViewChildren(ChildDirective) viewChildren !: QueryList<ChildDirective>; ngAfterViewInit() { // viewChildren is set } } 
      
      
  1. import {AfterViewInit, Component, Directive, QueryList, ViewChildren} from '@angular/core';
  2.  
  3. @Directive({selector: 'child-directive'})
  4. class ChildDirective {
  5. }
  6.  
  7. @Component({selector: 'someCmp', templateUrl: 'someCmp.html'})
  8. class SomeCmp implements AfterViewInit {
  9.   // TODO(issue/24571): remove '!'.
  10.   @ViewChildren(ChildDirective) viewChildren !: QueryList<ChildDirective>;
  11.  
  12.   ngAfterViewInit() {
  13.     // viewChildren is set
  14.   }
  15. }

Example

import {AfterViewInit, Component, Directive, Input, QueryList, ViewChildren} from '@angular/core'; @Directive({selector: 'pane'}) export class Pane { // TODO(issue/24571): remove '!'. @Input() id !: string; } @Component({ selector: 'example-app', template: ` <pane id="1"></pane> <pane id="2"></pane> <pane id="3" *ngIf="shouldShow"></pane> <button (click)="show()">Show 3</button> <div>panes: {{serializedPanes}}</div> `, }) export class ViewChildrenComp implements AfterViewInit { // TODO(issue/24571): remove '!'. @ViewChildren(Pane) panes !: QueryList<Pane>; serializedPanes: string = ''; shouldShow = false; show() { this.shouldShow = true; } ngAfterViewInit() { this.calculateSerializedPanes(); this.panes.changes.subscribe((r) => { this.calculateSerializedPanes(); }); } calculateSerializedPanes() { setTimeout(() => { this.serializedPanes = this.panes.map(p => p.id).join(', '); }, 0); } } 
      
      
  1. import {AfterViewInit, Component, Directive, Input, QueryList, ViewChildren} from '@angular/core';
  2.  
  3. @Directive({selector: 'pane'})
  4. export class Pane {
  5.   // TODO(issue/24571): remove '!'.
  6.   @Input() id !: string;
  7. }
  8.  
  9. @Component({
  10.   selector: 'example-app',
  11.   template: `
  12.     <pane id="1"></pane>
  13.     <pane id="2"></pane>
  14.     <pane id="3" *ngIf="shouldShow"></pane>
  15.     
  16.     <button (click)="show()">Show 3</button>
  17.        
  18.     <div>panes: {{serializedPanes}}</div> 
  19.   `,
  20. })
  21. export class ViewChildrenComp implements AfterViewInit {
  22.   // TODO(issue/24571): remove '!'.
  23.   @ViewChildren(Pane) panes !: QueryList<Pane>;
  24.   serializedPanes: string = '';
  25.  
  26.   shouldShow = false;
  27.  
  28.   show() { this.shouldShow = true; }
  29.  
  30.   ngAfterViewInit() {
  31.     this.calculateSerializedPanes();
  32.     this.panes.changes.subscribe((r) => { this.calculateSerializedPanes(); });
  33.   }
  34.  
  35.   calculateSerializedPanes() {
  36.     setTimeout(() => { this.serializedPanes = this.panes.map(p => p.id).join(', '); }, 0);
  37.   }
  38. }