*ngIf 中的@ViewChild

Question

问题

在显示模板中的相应元素后，获得 @ViewChild 的最优雅方法是什么？

下面是一个例子。也 Plunker 可用。

Component.template.html:

<div id="layout" *ngIf="display">
  <div #contentPlaceholder></div>
</div>

Component.component.ts:

export class AppComponent {

    display = false;
    @ViewChild('contentPlaceholder', { read: ViewContainerRef }) viewContainerRef;

    show() {
        this.display = true;
        console.log(this.viewContainerRef); // undefined
        setTimeout(() => {
            console.log(this.viewContainerRef); // OK
        }, 1);
    }
}

我有一个组件，其内容默认隐藏。当有人调用 show() 方法时，它就会变得可见。但是，在 Angular 2 变化检测完成之前，我无法引用 viewContainerRef。我通常将所有必需的操作包装到 setTimeout(()=>{},1) 中，如上所示。有没有更正确的方法？

我知道 ngAfterViewChecked 有一个选项，但它会导致太多无用的调用。

ANSWER (Plunker)

Answer 1

这可以工作，但我不知道它是否适合你的情况：

@ViewChildren('contentPlaceholder', {read: ViewContainerRef}) viewContainerRefs: QueryList;

ngAfterViewInit() {
 this.viewContainerRefs.changes.subscribe(item => {
   if(this.viewContainerRefs.toArray().length) {
     // shown
   }
 })
}

Answer 2

为 ViewChild 使用 setter：

 private contentPlaceholder: ElementRef;

 @ViewChild('contentPlaceholder') set content(content: ElementRef) {
    if(content) { // initially setter gets called with undefined
        this.contentPlaceholder = content;
    }
 }

一旦 *ngIf 变为 true，将使用元素引用调用 setter。

请注意，对于 Angular 8，您必须确保设置 { static: false }，这是其他 Angular 版本中的默认设置：

 @ViewChild('contentPlaceholder', { static: false })

注意：如果 contentPlaceholder 是一个组件，您可以将 ElementRef 更改为您的组件 Class:

  private contentPlaceholder: MyCustomComponent;

  @ViewChild('contentPlaceholder') set content(content: MyCustomComponent) {
     if(content) { // initially setter gets called with undefined
          this.contentPlaceholder = content;
     }
  }

Answer 3

正如其他人所提到的，最快最快的解决方案是使用 [hidden] 而不是 *ngIf。采用这种方法，组件将被创建但不可见，因此您可以访问它。这可能不是最有效的方法。

Answer 4

上面的答案对我不起作用，因为在我的项目中，ngIf 在输入元素上。我需要访问 nativeElement 属性以便在 ngIf 为真时关注输入。 ViewContainerRef 上似乎没有 nativeElement 属性。这是我所做的（在 @ViewChild documentation 之后）：

<button (click)='showAsset()'>Add Asset</button>
<div *ngIf='showAssetInput'>
    <input #assetInput />
</div>

...

private assetInputElRef:ElementRef;
@ViewChild('assetInput') set assetInput(elRef: ElementRef) {
    this.assetInputElRef = elRef;
}

...

showAsset() {
    this.showAssetInput = true;
    setTimeout(() => { this.assetInputElRef.nativeElement.focus(); });
}

我在聚焦之前使用了 setTimeout，因为 ViewChild 需要一秒钟才能分配。否则它将是未定义的。

Answer 5

解决此问题的另一种方法是运行手动更改检测器。

你先注入 ChangeDetectorRef:

constructor(private changeDetector : ChangeDetectorRef) {}

然后在更新控制 *ngIf

的变量后调用它

show() {
        this.display = true;
        this.changeDetector.detectChanges();
    }

Answer 6

我的目标是避免任何假设某些东西（例如 setTimeout）的 hacky 方法，我最终实现了接受的解决方案，上面有一点 RxJS 风格：

  private ngUnsubscribe = new Subject();
  private tabSetInitialized = new Subject();
  public tabSet: TabsetComponent;
  @ViewChild('tabSet') set setTabSet(tabset: TabsetComponent) {
    if (!!tabSet) {
      this.tabSet = tabSet;
      this.tabSetInitialized.next();
    }
  }

  ngOnInit() {
    combineLatest(
      this.route.queryParams,
      this.tabSetInitialized
    ).pipe(
      takeUntil(this.ngUnsubscribe)
    ).subscribe(([queryParams, isTabSetInitialized]) => {
      let tab = [undefined, 'translate', 'versions'].indexOf(queryParams['view']);
      this.tabSet.tabs[tab > -1 ? tab : 0].active = true;
    });
  }

我的场景： 我想根据路由器 queryParams 在 @ViewChild 元素上触发一个动作。由于在 HTTP 请求 returns 数据之前包装 *ngIf 为假，因此 @ViewChild 元素的初始化发生延迟。

它是如何工作的： combineLatest 仅当每个提供的 Observables 从 [=16= 时刻发出第一个值时才第一次发出一个值] 已订阅。当设置 @ViewChild 元素时，我的主题 tabSetInitialized 发出一个值。因此，我延迟执行 subscribe 下的代码，直到 *ngIf 变为正并且 @ViewChild 被初始化。

当然不要忘记取消订阅 ngOnDestroy，我使用 ngUnsubscribe 主题：

  ngOnDestroy() {
    this.ngUnsubscribe.next();
    this.ngUnsubscribe.complete();
  }

Answer 7

一个简化版本，我在使用 Google Maps JS SDK 时遇到了类似的问题。

我的解决方案是将 div 和 ViewChild 提取到它自己的子组件中，当在父组件中使用时可以 hid/displayed 使用 *ngIf .

之前

HomePageComponent 模板

<div *ngIf="showMap">
  <div #map id="map" class="map-container"></div>
</div>

HomePageComponent 组件

@ViewChild('map') public mapElement: ElementRef; 

public ionViewDidLoad() {
    this.loadMap();
});

private loadMap() {

  const latLng = new google.maps.LatLng(-1234, 4567);
  const mapOptions = {
    center: latLng,
    zoom: 15,
    mapTypeId: google.maps.MapTypeId.ROADMAP,
  };
   this.map = new google.maps.Map(this.mapElement.nativeElement, mapOptions);
}

public toggleMap() {
  this.showMap = !this.showMap;
 }

之后

MapComponent 模板

 <div>
  <div #map id="map" class="map-container"></div>
</div>

MapComponent 组件

@ViewChild('map') public mapElement: ElementRef; 

public ngOnInit() {
    this.loadMap();
});

private loadMap() {

  const latLng = new google.maps.LatLng(-1234, 4567);
  const mapOptions = {
    center: latLng,
    zoom: 15,
    mapTypeId: google.maps.MapTypeId.ROADMAP,
  };
   this.map = new google.maps.Map(this.mapElement.nativeElement, mapOptions);
}

HomePageComponent 模板

<map *ngIf="showMap"></map>

HomePageComponent 组件

public toggleMap() {
  this.showMap = !this.showMap;
 }

Answer 8

另一个快速 "trick"（简单的解决方案） 只是使用 [hidden] 标签而不是 *ngIf，重要的是要知道在那种情况下 Angular 构建对象并在 class:hidden 下绘制它，这就是 ViewChild 可以正常工作的原因。 因此请务必记住，您不应在可能导致性能问题的重物或昂贵物品上使用 hidden

  <div class="addTable" [hidden]="CONDITION">

Answer 9

在我的例子中，只有当 div 存在于模板中时，我才需要加载整个模块，这意味着出口在 ngif 中。这样，每次 angular 检测到元素 #geolocalisationOutlet 时，它都会在其中创建组件。该模块也只加载一次。

constructor(
    public wlService: WhitelabelService,
    public lmService: LeftMenuService,
    private loader: NgModuleFactoryLoader,
    private injector: Injector
) {
}

@ViewChild('geolocalisationOutlet', {read: ViewContainerRef}) set geolocalisation(geolocalisationOutlet: ViewContainerRef) {
    const path = 'src/app/components/engine/sections/geolocalisation/geolocalisation.module#GeolocalisationModule';
    this.loader.load(path).then((moduleFactory: NgModuleFactory<any>) => {
        const moduleRef = moduleFactory.create(this.injector);
        const compFactory = moduleRef.componentFactoryResolver
            .resolveComponentFactory(GeolocalisationComponent);
        if (geolocalisationOutlet && geolocalisationOutlet.length === 0) {
            geolocalisationOutlet.createComponent(compFactory);
        }
    });
}

<div *ngIf="section === 'geolocalisation'" id="geolocalisation">
     <div #geolocalisationOutlet></div>
</div>

Answer 10

我认为使用 defer from lodash 很有意义，尤其是在我的 @ViewChild() 位于 async 管道

内的情况下

Answer 11

Angular 8+

您应该添加 { static: false } 作为 @ViewChild 的第二个选项。这会导致在更改检测运行后解析查询结果，从而允许您的 @ViewChild 在值更改后更新。

示例：

export class AppComponent {
    @ViewChild('contentPlaceholder', { static: false }) contentPlaceholder: ElementRef;

    display = false;

    constructor(private changeDetectorRef: ChangeDetectorRef) {
    }

    show() {
        this.display = true;

        // Required to access this.contentPlaceholder below,
        // otherwise contentPlaceholder will be undefined
        this.changeDetectorRef.detectChanges();

        console.log(this.contentPlaceholder);
    }
}

Stackblitz 示例：https://stackblitz.com/edit/angular-d8ezsn

Answer 12

正在处理 Angular 8 无需导入 ChangeDector

ngIf 允许您不加载元素并避免给您的应用程序增加更多压力。这是我在没有 ChangeDetector

的情况下得到它的方法运行

elem: ElementRef;

@ViewChild('elemOnHTML', {static: false}) set elemOnHTML(elemOnHTML: ElementRef) {
    if (!!elemOnHTML) {
      this.elem = elemOnHTML;
    }
}

然后，当我将 ngIf 值更改为 truthy 时，我会像这样使用 setTimeout，让它只等待下一个更改周期：

  this.showElem = true;
  console.log(this.elem); // undefined here
  setTimeout(() => {
    console.log(this.elem); // back here through ViewChild set
    this.elem.do();
  });

这也让我避免使用任何额外的库或导入。

Answer 13

for Angular 8 - 空值检查和 @ViewChild static: false hackery

的混合体

对于等待异步数据的分页控件

@ViewChild(MatPaginator, { static: false }) set paginator(paginator: MatPaginator) {
  if(!paginator) return;
  paginator.page.pipe(untilDestroyed(this)).subscribe(pageEvent => {
    const updated: TSearchRequest = {
      pageRef: pageEvent.pageIndex,
      pageSize: pageEvent.pageSize
    } as any;
    this.dataGridStateService.alterSearchRequest(updated);
  });
}

Answer 14

如果我在 Angular 9

中使用 ChangeDetectorRef，它对我有用

@ViewChild('search', {static: false})
public searchElementRef: ElementRef;

constructor(private changeDetector: ChangeDetectorRef) {}

//then call this when this.display = true;
show() {
   this.display = true;
   this.changeDetector.detectChanges();
}

Answer 15

只需确保 static 选项设置为 false

  @ViewChild('contentPlaceholder', {static: false}) contentPlaceholder: ElementRef;

Answer 16

我自己遇到了同样的问题， Angular 10.

如果我尝试使用 [hidden] 或 *ngIf，那么 @ViewChild 变量总是 undefined.

<p-calendar #calendar *ngIf="bShowCalendar" >
</p-calendar>

我通过 而不是 将其从网页中删除来修复它。
我使用 [ngClass] 使控件具有 opacity:0，并将其完全移开。

<style>
  .notVisible {
    opacity: 0;
    left: -1000px;
    position: absolute !important;
  }
</style>

<p-calendar #calendar [ngClass]="{'notVisible': bShowCalendar }" >
</p-calendar>

是的，我知道，它又蠢又丑，但它解决了问题。

我还必须使控件静态。我不明白为什么..但是，如果没有这个改变，它又拒绝工作：

export class DatePickerCellRenderer {
    @ViewChild('calendar', {static: true }) calendar: Calendar;

Answer 17

如果 setter 似乎无法与 @ViewChild 一起工作（根本没有被调用），请尝试 @ContentChild。

Answer 18

We had a situation to set tabindex on ngif

html:

<div #countryConditional1 *ngIf="country=='USA'">                        
<input id="streetNumber"  [(ngModel)]="streetNumber" pInputText>
</div>

ts:

@ViewChild('countryConditional1') set countryConditional1(element){
        if (element){
            const container2 = document.querySelector("#someElement");
            container2.querySelector("span > input").setAttribute("tabindex", "18");}

Answer 19

阅读并尝试这个

Make sure passing the param { static: false } to @ViewChild resolve the problem.

**template.html code**

  <div *ngIf="showFirtChild">
    <first-child #firstchildComponent ></first-child>
  </div>

**in .ts file**

export class Parent implements 
{
  private firstChild: FirstchildComponent;

  @ViewChild('firstchildComponent', { static: false }) set content(content: 
  FirstchildComponent) {
     if(content) { 
          this.firstchildComponent = content;
     }
  }

 constructor(){}

  ShowChild(){
     this.showFirtChild = true;
     if(this.firstchildComponent){
        this.firstchildComponent.YourMethod()
     }
  }

}

*ngIf 中的@ViewChild

@ViewChild in *ngIf

angular

angular2-changedetection

viewchild

问题

ANSWER (Plunker)