Angular 2 @ViewChild аннотация возвращает неопределенное


242

Я пытаюсь выучить Angular 2.

Я хотел бы получить доступ к дочернему компоненту из родительского компонента, используя аннотацию @ViewChild .

Вот несколько строк кода:

В BodyContent.ts у меня есть:

import {ViewChild, Component, Injectable} from 'angular2/core';
import {FilterTiles} from '../Components/FilterTiles/FilterTiles';


@Component({
selector: 'ico-body-content'
, templateUrl: 'App/Pages/Filters/BodyContent/BodyContent.html'
, directives: [FilterTiles] 
})


export class BodyContent {
    @ViewChild(FilterTiles) ft:FilterTiles;

    public onClickSidebar(clickedElement: string) {
        console.log(this.ft);
        var startingFilter = {
            title: 'cognomi',
            values: [
                'griffin'
                , 'simpson'
            ]}
        this.ft.tiles.push(startingFilter);
    } 
}

в то время как в FilterTiles.ts :

 import {Component} from 'angular2/core';


 @Component({
     selector: 'ico-filter-tiles'
    ,templateUrl: 'App/Pages/Filters/Components/FilterTiles/FilterTiles.html'
 })


 export class FilterTiles {
     public tiles = [];

     public constructor(){};
 }

Наконец, вот шаблоны (как это предлагается в комментариях):

BodyContent.html

<div (click)="onClickSidebar()" class="row" style="height:200px; background-color:red;">
        <ico-filter-tiles></ico-filter-tiles>
    </div>

FilterTiles.html

<h1>Tiles loaded</h1>
<div *ngFor="#tile of tiles" class="col-md-4">
     ... stuff ...
</div>

Шаблон FilterTiles.html правильно загружен в тег ico-filter- tile (действительно, я вижу заголовок).

Примечание: класс BodyContent внедряется внутри другого шаблона (Body) с использованием DynamicComponetLoader: dcl.loadAsRoot (BodyContent, '# ico-bodyContent', инжектор):

import {ViewChild, Component, DynamicComponentLoader, Injector} from 'angular2/core';
import {Body}                 from '../../Layout/Dashboard/Body/Body';
import {BodyContent}          from './BodyContent/BodyContent';

@Component({
    selector: 'filters'
    , templateUrl: 'App/Pages/Filters/Filters.html'
    , directives: [Body, Sidebar, Navbar]
})


export class Filters {

    constructor(dcl: DynamicComponentLoader, injector: Injector) {
       dcl.loadAsRoot(BodyContent, '#ico-bodyContent', injector);
       dcl.loadAsRoot(SidebarContent, '#ico-sidebarContent', injector);

   } 
}

Проблема в том, что, когда я пытаюсь записать ftв консольный журнал, я получаю undefined, и, конечно, получаю исключение, когда пытаюсь вставить что-то в массив «tile»: «нет плиток свойства для« undefined »» .

Еще одна вещь: компонент FilterTiles, кажется, правильно загружен, так как я могу видеть HTML-шаблон для него.

Любое предложение? Спасибо


Выглядит правильно. Может быть, что-то с шаблоном, но это не входит в ваш вопрос.
Гюнтер Цохбауэр

1
Договорились с Гюнтером. Я создал план с вашим кодом и простыми связанными шаблонами, и он работает. Смотрите эту ссылку: plnkr.co/edit/KpHp5Dlmppzo1LXcutPV?p=preview . Нам нужны шаблоны ;-)
Тьерри Темплиер

1
ftне будет установлен в конструкторе, но в обработчике события щелчка он будет уже установлен.
Гюнтер Цохбауэр

5
Вы используете loadAsRoot, у которого есть известная проблема с обнаружением изменений. Просто чтобы убедиться, попробуйте использовать loadNextToLocationили loadIntoLocation.
Эрик Мартинес

1
Проблема была loadAsRoot. Как только я заменил loadIntoLocationна проблему была решена. Если вы
оставите

Ответы:


374

У меня была похожая проблема, и я решил опубликовать ее на тот случай, если кто-то еще совершит ту же ошибку Во-первых, нужно учитывать одну вещь AfterViewInit; вам нужно дождаться инициализации представления, прежде чем вы сможете получить к нему доступ @ViewChild. Тем не менее, мой @ViewChildвсе еще возвращался ноль. Проблема была моей *ngIf. *ngIfДиректива убивали мое управление компонентами , так что я не мог ссылаться на него.

import {Component, ViewChild, OnInit, AfterViewInit} from 'angular2/core';
import {ControlsComponent} from './controls/controls.component';
import {SlideshowComponent} from './slideshow/slideshow.component';

@Component({
    selector: 'app',
    template:  `
        <controls *ngIf="controlsOn"></controls>
        <slideshow (mousemove)="onMouseMove()"></slideshow>
    `,
    directives: [SlideshowComponent, ControlsComponent]
})

export class AppComponent {
    @ViewChild(ControlsComponent) controls:ControlsComponent;

    controlsOn:boolean = false;

    ngOnInit() {
        console.log('on init', this.controls);
        // this returns undefined
    }

    ngAfterViewInit() {
        console.log('on after view init', this.controls);
        // this returns null
    }

    onMouseMove(event) {
         this.controls.show();
         // throws an error because controls is null
    }
}

Надеюсь, это поможет.

РЕДАКТИРОВАТЬ
Как упоминалось @Ashg ниже , решение заключается в использовании @ViewChildrenвместо @ViewChild.


9
@kenecaswell Итак, вы нашли лучший способ решить проблему. Я также сталкиваюсь с той же проблемой. У меня есть много * ngIf, так что элемент будет единственным после всех истинных, но мне нужна ссылка на элемент. Любой способ решить эту проблему>
Моника

4
Я обнаружил, что дочерний компонент не определен в ngAfterViewInit () при использовании ngIf. Я пытался поставить длинные таймауты, но все равно ничего не получалось Однако дочерний компонент доступен позже (т. Е. В ответ на события щелчка и т. Д.). Если я не использую ngIf, и он определен, как ожидается, в ngAfterViewInit (). Подробнее об общении между
Мэтью Хегарти,

3
Я использовал bootstrap ngClass+ hiddenclass вместо ngIf. Это сработало. Спасибо!
Рахматулла М

9
Это не решает проблему, используйте приведенное ниже решение, используя @ViewChildren. Получите ссылку на дочерний элемент управления, как только он станет доступен
Ashg

20
Это только доказывает «проблему», верно? Это не опубликовать решение.
Мигель Рибейро

146

Проблема, как упоминалось ранее, заключается в том, ngIfчто представление не определено. Ответ должен использовать ViewChildrenвместо ViewChild. У меня была похожая проблема, когда я не хотел, чтобы сетка отображалась, пока не были загружены все справочные данные.

HTML:

   <section class="well" *ngIf="LookupData != null">
       <h4 class="ra-well-title">Results</h4>
       <kendo-grid #searchGrid> </kendo-grid>
   </section>

Код компонента

import { Component, ViewChildren, OnInit, AfterViewInit, QueryList  } from '@angular/core';
import { GridComponent } from '@progress/kendo-angular-grid';

export class SearchComponent implements OnInit, AfterViewInit
{
    //other code emitted for clarity

    @ViewChildren("searchGrid")
    public Grids: QueryList<GridComponent>

    private SearchGrid: GridComponent

    public ngAfterViewInit(): void
    {

        this.Grids.changes.subscribe((comps: QueryList <GridComponent>) =>
        {
            this.SearchGrid = comps.first;
        });


    }
}

Здесь мы используем, ViewChildrenна котором вы можете прослушать изменения. В этом случае любые дети со ссылкой #searchGrid. Надеюсь это поможет.


4
Я хотел бы добавить, что в некоторых случаях, когда вы пытаетесь изменить, например. this.SearchGridсвойства, которые вы должны использовать, например, синтаксис, setTimeout(()=>{ ///your code here }, 1); чтобы избежать исключения: выражение изменилось после того, как оно было проверено
rafalkasa

3
Как это сделать, если вы хотите поместить свой тег #searchGrid в обычный элемент HTML вместо элемента Angular2? (Например, <div #searchGrid> </ div>, и это внутри блока * ngIf?
Верн Дженсен

1
это правильный ответ для моего варианта использования! Спасибо, мне нужен доступ к компоненту, так как он доступен через ngIf =
Frozen_byte

1
это отлично работает с ответами ajax, теперь *ngIfработает, и после рендера мы можем сохранить ElementRef из динамических компонентов.
elporfirio

4
Также не забудьте назначить его подписке, а затем отписаться от нее
tam.teixeira

64

Вы могли бы использовать сеттер для @ViewChild()

@ViewChild(FilterTiles) set ft(tiles: FilterTiles) {
    console.log(tiles);
};

Если у вас есть оболочка ngIf, сеттер будет вызываться с неопределенным значением, а затем снова со ссылкой, как только ngIf разрешит его рендеринг.

Моя проблема была чем-то еще, хотя. Я не включил модуль, содержащий мои «FilterTiles» в мои app.modules. Шаблон не выдавал ошибку, но ссылка всегда была неопределенной.


3
Это не работает для меня - я получаю первый неопределенный, но я не получаю второй звонок со ссылкой. Приложение ng2 ... это функция ng4 +?
Джей Камминс

@ Джей, я думаю, это потому, что в этом случае вы не зарегистрировали компонент в Angular FilterTiles. Я столкнулся с этой проблемой по этой причине раньше.
парламент

1
Работает для Angular 8 с использованием #paginator для html-элемента и аннотаций, таких как@ViewChild('paginator', {static: false})
Qiteq

1
Это обратный вызов для изменений ViewChild?
Ясир Насименто

24

Это сработало для меня.

Например, мой компонент с именем 'my-component' отображался с использованием * ngIf = "showMe" следующим образом:

<my-component [showMe]="showMe" *ngIf="showMe"></my-component>

Таким образом, когда компонент инициализируется, компонент еще не отображается, пока "showMe" не станет true. Таким образом, все мои ссылки @ViewChild были неопределенными.

Здесь я использовал @ViewChildren и QueryList, который он возвращает. Смотрите угловую статью о QueryList и демонстрацию использования @ViewChildren .

Вы можете использовать QueryList, который возвращает @ViewChildren, и подписаться на любые изменения ссылочных элементов, используя rxjs, как показано ниже. @ViewChild не имеет этой способности.

import { Component, ViewChildren, ElementRef, OnChanges, QueryList, Input } from '@angular/core';
import 'rxjs/Rx';

@Component({
    selector: 'my-component',
    templateUrl: './my-component.component.html',
    styleUrls: ['./my-component.component.css']
})
export class MyComponent implements OnChanges {

  @ViewChildren('ref') ref: QueryList<any>; // this reference is just pointing to a template reference variable in the component html file (i.e. <div #ref></div> )
  @Input() showMe; // this is passed into my component from the parent as a    

  ngOnChanges () { // ngOnChanges is a component LifeCycle Hook that should run the following code when there is a change to the components view (like when the child elements appear in the DOM for example)
    if(showMe) // this if statement checks to see if the component has appeared becuase ngOnChanges may fire for other reasons
      this.ref.changes.subscribe( // subscribe to any changes to the ref which should change from undefined to an actual value once showMe is switched to true (which triggers *ngIf to show the component)
        (result) => {
          // console.log(result.first['_results'][0].nativeElement);                                         
          console.log(result.first.nativeElement);                                          

          // Do Stuff with referenced element here...   
        } 
      ); // end subscribe
    } // end if
  } // end onChanges 
} // end Class

Надеюсь, что это поможет кому-то сэкономить время и разочарование.


3
На самом деле, ваше решение кажется наилучшим из перечисленных. ПРИМЕЧАНИЕ. Мы должны помнить, что решение 73 высшего уровня теперь УСТАРЕЛО ... так как директива: [...] объявление больше не поддерживается в Angular 4. IOW не будет работать в сценарии Angular 4
PeteZaria

5
Не забудьте отписаться или использовать .take(1).subscribe(), но отличный ответ, большое спасибо!
Блэр Коннолли

2
Отличное решение. Я подписался на изменения ref в ngAfterViewInit (), а не в ngOnChanges (). Но мне пришлось добавить setTimeout, чтобы избавиться от ошибки ExpressionChangedAfterChecked
Josf

Это должно быть помечено как фактическое решение. Большое спасибо!
Platzhersh

10

Мой обходной путь должен был использовать [style.display]="getControlsOnStyleDisplay()"вместо *ngIf="controlsOn". Блок есть, но он не отображается.

@Component({
selector: 'app',
template:  `
    <controls [style.display]="getControlsOnStyleDisplay()"></controls>
...

export class AppComponent {
  @ViewChild(ControlsComponent) controls:ControlsComponent;

  controlsOn:boolean = false;

  getControlsOnStyleDisplay() {
    if(this.controlsOn) {
      return "block";
    } else {
      return "none";
    }
  }
....

Создайте страницу, где список элементов отображается в таблице или элемент редактирования отображается на основе значения переменной showList. Избавился от надоедливой ошибки консоли, используя [style.display] = "! ShowList" в сочетании с * ngIf = "! ShowList".
Разваноне

9

Что решило мою проблему, так это убедиться, что staticустановлено false.

@ViewChild(ClrForm, {static: false}) clrForm;

При staticотключении @ViewChildссылка обновляется Angular при *ngIfизменении директивы.


1
Это почти идеальный ответ, просто укажу, что это хорошая практика, чтобы также проверять обнуляемые значения, поэтому мы получаем что-то вроде этого: @ViewChild (ClrForm, {static: false}) set clrForm (clrForm: ClrForm) {if (clrForm) {this.clrForm = clrForm; }};
Клаус Кляйн

Я перепробовал много вещей и, наконец, нашел эту вещь виновником.
Маниш Шарма

8

Мое решение этого было заменить *ngIf на [hidden]. Недостатком было то, что все дочерние компоненты присутствовали в коде DOM. Но работал для моих требований.


5

В моем случае у меня был установщик входной переменной, использующий директиву ViewChild, и ViewChildбыл внутри *ngIfдирективы, поэтому сеттер пытался получить к ней доступ перед *ngIfвизуализацией (без нее он работал бы нормально *ngIf, но не работал бы, если бы всегда было установлено значение правда с *ngIf="true").

Чтобы решить эту проблему, я использовал Rxjs, чтобы убедиться, что любая ссылка на ожидание, ViewChildпока представление не было инициировано. Сначала создайте тему, которая завершается, когда после просмотра инициализации.

export class MyComponent implements AfterViewInit {
  private _viewInitWaiter$ = new Subject();

  ngAfterViewInit(): void {
    this._viewInitWaiter$.complete();
  }
}

Затем создайте функцию, которая принимает и выполняет лямбду после завершения субъекта.

private _executeAfterViewInit(func: () => any): any {
  this._viewInitWaiter$.subscribe(null, null, () => {
    return func();
  })
}

Наконец, убедитесь, что ссылки на ViewChild используют эту функцию.

@Input()
set myInput(val: any) {
    this._executeAfterViewInit(() => {
        const viewChildProperty = this.viewChild.someProperty;
        ...
    });
}

@ViewChild('viewChildRefName', {read: MyViewChildComponent}) viewChild: MyViewChildComponent;

1
Это гораздо лучшее решение, чем вся бессмысленная бессмыслица
Лиам

4

Это должно работать.

Но, как сказал Гюнтер Цохбауэр, в шаблоне должна быть другая проблема. Я создал своего рода Релевант-Плункр-Ответ . Пожалуйста, проверьте консоль браузера.

boot.ts

@Component({
selector: 'my-app'
, template: `<div> <h1> BodyContent </h1></div>

      <filter></filter>

      <button (click)="onClickSidebar()">Click Me</button>
  `
, directives: [FilterTiles] 
})


export class BodyContent {
    @ViewChild(FilterTiles) ft:FilterTiles;

    public onClickSidebar() {
        console.log(this.ft);

        this.ft.tiles.push("entered");
    } 
}

filterTiles.ts

@Component({
     selector: 'filter',
    template: '<div> <h4>Filter tiles </h4></div>'
 })


 export class FilterTiles {
     public tiles = [];

     public constructor(){};
 }

Работает как часы. Пожалуйста, проверьте ваши теги и ссылки.

Спасибо...


1
Если проблема такая же, как у меня, для дублирования вам нужно поместить * ngIf в шаблон вокруг <filter> </ filter>. Очевидно, что если ngIf возвращает false, ViewChild не подключается и возвращает null
Dan Погоня

2

Это работает для меня, см. Пример ниже.

import {Component, ViewChild, ElementRef} from 'angular2/core';

@Component({
    selector: 'app',
    template:  `
        <a (click)="toggle($event)">Toggle</a>
        <div *ngIf="visible">
          <input #control name="value" [(ngModel)]="value" type="text" />
        </div>
    `,
})

export class AppComponent {

    private elementRef: ElementRef;
    @ViewChild('control') set controlElRef(elementRef: ElementRef) {
      this.elementRef = elementRef;
    }

    visible:boolean;

    toggle($event: Event) {
      this.visible = !this.visible;
      if(this.visible) {
        setTimeout(() => { this.elementRef.nativeElement.focus(); });
      }
    }

}


2

У меня была похожая проблема, когда ViewChildвнутри было switchпредложение, которое не загружало элемент viewChild до ссылки на него. Я решил это полукакомным способом, но обернул ViewChildссылку в тот, setTimeoutкоторый выполнялся немедленно (то есть 0 мс)


1

Мое решение этого состояло в том, чтобы переместить ngIf снаружи дочернего компонента внутрь дочернего компонента в div, который обернул весь раздел html. Таким образом, он все еще скрывался, когда это было необходимо, но смог загрузить компонент, и я мог ссылаться на него в родительском.


Но для этого, как вы попали к своей «видимой» переменной, которая была в родительском?
Дэн Чейз

1

Я исправляю это, просто добавляя SetTimeout после установки видимого компонента

Мой HTML:

<input #txtBus *ngIf[show]>

Мой Компонент JS

@Component({
  selector: "app-topbar",
  templateUrl: "./topbar.component.html",
  styleUrls: ["./topbar.component.scss"]
})
export class TopbarComponent implements OnInit {

  public show:boolean=false;

  @ViewChild("txtBus") private inputBusRef: ElementRef;

  constructor() {

  }

  ngOnInit() {}

  ngOnDestroy(): void {

  }


  showInput() {
    this.show = true;
    setTimeout(()=>{
      this.inputBusRef.nativeElement.focus();
    },500);
  }
}

1

В моем случае я знал, что дочерний компонент всегда будет присутствовать, но хотел изменить состояние до инициализации дочернего элемента, чтобы сохранить работу.

Я выбираю тестирование на ребенка, пока он не появится, и сразу же внесу изменения, что спасло меня от цикла изменений дочернего компонента.

export class GroupResultsReportComponent implements OnInit {

    @ViewChild(ChildComponent) childComp: ChildComponent;

    ngOnInit(): void {
        this.WhenReady(() => this.childComp, () => { this.childComp.showBar = true; });
    }

    /**
     * Executes the work, once the test returns truthy
     * @param test a function that will return truthy once the work function is able to execute 
     * @param work a function that will execute after the test function returns truthy
     */
    private WhenReady(test: Function, work: Function) {
        if (test()) work();
        else setTimeout(this.WhenReady.bind(window, test, work));
    }
}

В качестве предупреждения вы можете добавить максимальное количество попыток или добавить задержку в несколько мс setTimeout. setTimeoutэффективно бросает функцию в конец списка ожидающих операций.


0

Некий общий подход:

Вы можете создать метод, который будет ждать, пока ViewChildне будет готов

function waitWhileViewChildIsReady(parent: any, viewChildName: string, refreshRateSec: number = 50, maxWaitTime: number = 3000): Observable<any> {
  return interval(refreshRateSec)
    .pipe(
      takeWhile(() => !isDefined(parent[viewChildName])),
      filter(x => x === undefined),
      takeUntil(timer(maxWaitTime)),
      endWith(parent[viewChildName]),
      flatMap(v => {
        if (!parent[viewChildName]) throw new Error(`ViewChild "${viewChildName}" is never ready`);
        return of(!parent[viewChildName]);
      })
    );
}


function isDefined<T>(value: T | undefined | null): value is T {
  return <T>value !== undefined && <T>value !== null;
}

Использование:

  // Now you can do it in any place of your code
  waitWhileViewChildIsReady(this, 'yourViewChildName').subscribe(() =>{
      // your logic here
  })

0

Для меня проблема заключалась в том, что я ссылался на идентификатор элемента.

@ViewChild('survey-form') slides:IonSlides;

<div id="survey-form"></div>

Вместо этого:

@ViewChild('surveyForm') slides:IonSlides;

<div #surveyForm></div>

0

Если вы используете Ionic, вам нужно использовать ionViewDidEnter()хук жизненного цикла. Ионные запускает некоторый дополнительный материал ( в основном анимации , связанной с ) , который обычно вызывает неожиданные ошибки , как это, следовательно , потребность в чем - то , что работает после ngOnInit , ngAfterContentInitи так далее.


-1

Вот кое-что, что сработало для меня.

@ViewChild('mapSearch', { read: ElementRef }) mapInput: ElementRef;

ngAfterViewInit() {
  interval(1000).pipe(
        switchMap(() => of(this.mapInput)),
        filter(response => response instanceof ElementRef),
        take(1))
        .subscribe((input: ElementRef) => {
          //do stuff
        });
}

Таким образом, я в основном устанавливаю проверку каждую секунду, пока не *ngIfстанет правдой, а затем я делаю свои вещи, связанные с ElementRef.


-3

Решение, которое работало для меня, состояло в том, чтобы добавить директиву в объявлениях в app.module.ts

Используя наш сайт, вы подтверждаете, что прочитали и поняли нашу Политику в отношении файлов cookie и Политику конфиденциальности.
Licensed under cc by-sa 3.0 with attribution required.