ContentChildren
用于配置内容查询的参数装饰器。
Parameter decorator that configures a content query.
说明
用于从内容 DOM 中获取元素或指令的 QueryList
。每当添加、删除或移动子元素时,此查询列表都会更新,并且其可观察对象 changes 都会发出新值。
Use to get the QueryList
of elements or directives from the content 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.
在调用 ngAfterContentInit
回调之前设置的内容查询。
Content queries are set before the ngAfterContentInit
callback is called.
不检索其他组件模板中的元素或指令,因为组件模板对其祖先来说始终是黑匣子。
Does not retrieve elements or directives that are in other components' templates, since a component's template is always a black box to its ancestors.
元数据属性:
Metadata Properties:
selector - 要查询的指令类型或名称。
selector - The directive type or the name used for querying.
后代 - 包含所有后代时为 true,否则仅包括直接子代。
descendants - If
true
include all descendants of the element. Iffalse
then only query direct children of the element.emitDistinctChangesOnly - The
QueryList#changes
observable will emit new values only if the QueryList result has changed. Whenfalse
thechanges
observable might emit even if the QueryList has not changed. Note: * This config option is deprecated, it will be permanently set totrue
and removed in future versions of Angular.read - 用于从查询到的元素中读取不同的令牌。
read - Used to read a different token from the queried elements.
Further information available in the Usage Notes...
使用说明
这里是如何使用 ContentChildren
装饰器的简单演示。
Here is a simple demonstration of how the ContentChildren
decorator can be used.
import {AfterContentInit, ContentChildren, Directive, QueryList} from '@angular/core';
@Directive({selector: 'child-directive'})
class ChildDirective {
}
@Directive({selector: 'someDir'})
class SomeDir implements AfterContentInit {
@ContentChildren(ChildDirective) contentChildren!: QueryList<ChildDirective>;
ngAfterContentInit() {
// contentChildren is set
}
}
Tab-pane example
Here is a slightly more realistic example that shows how ContentChildren
decorators can be used to implement a tab pane component.
import {Component, ContentChildren, Directive, Input, QueryList} from '@angular/core';
@Directive({selector: 'pane'})
export class Pane {
@Input() id!: string;
}
@Component({
selector: 'tab',
template: `
<div class="top-level">Top level panes: {{serializedPanes}}</div>
<div class="nested">Arbitrary nested panes: {{serializedNestedPanes}}</div>
`
})
export class Tab {
@ContentChildren(Pane) topLevelPanes!: QueryList<Pane>;
@ContentChildren(Pane, {descendants: true}) arbitraryNestedPanes!: QueryList<Pane>;
get serializedPanes(): string {
return this.topLevelPanes ? this.topLevelPanes.map(p => p.id).join(', ') : '';
}
get serializedNestedPanes(): string {
return this.arbitraryNestedPanes ? this.arbitraryNestedPanes.map(p => p.id).join(', ') : '';
}
}
@Component({
selector: 'example-app',
template: `
<tab>
<pane id="1"></pane>
<pane id="2"></pane>
<pane id="3" *ngIf="shouldShow">
<tab>
<pane id="3_1"></pane>
<pane id="3_2"></pane>
</tab>
</pane>
</tab>
<button (click)="show()">Show 3</button>
`,
})
export class ContentChildrenComp {
shouldShow = false;
show() {
this.shouldShow = true;
}
}