docs(core): updates query decorator docs
This commit is contained in:
parent
5972fdc817
commit
096ae7c404
|
@ -155,7 +155,35 @@ export abstract class Query {}
|
||||||
*/
|
*/
|
||||||
export interface ContentChildrenDecorator {
|
export interface ContentChildrenDecorator {
|
||||||
/**
|
/**
|
||||||
* @docsNotRequired
|
* @whatItDoes Configures a content query.
|
||||||
|
*
|
||||||
|
* @howToUse
|
||||||
|
*
|
||||||
|
* {@example core/di/ts/contentChildren/content_children_howto.ts region='HowTo'}
|
||||||
|
*
|
||||||
|
* @description
|
||||||
|
*
|
||||||
|
* You can use ContentChildren to get the {@link 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.
|
||||||
|
*
|
||||||
|
* Content queries are set before the `ngAfterContentInit` callback is called.
|
||||||
|
*
|
||||||
|
* **Metadata Properties**:
|
||||||
|
*
|
||||||
|
* * **selector** - the directive type or the name used for querying.
|
||||||
|
* * **descendants** - include only direct children or all descendants.
|
||||||
|
* * **read** - read a different token from the queried elements.
|
||||||
|
*
|
||||||
|
* Let's look at an example:
|
||||||
|
*
|
||||||
|
* {@example core/di/ts/contentChildren/content_children_example.ts region='Component'}
|
||||||
|
*
|
||||||
|
* **npm package**: `@angular/core`
|
||||||
|
*
|
||||||
|
* @stable
|
||||||
|
* @Annotation
|
||||||
*/
|
*/
|
||||||
(selector: Type<any>|Function|string,
|
(selector: Type<any>|Function|string,
|
||||||
{descendants, read}?: {descendants?: boolean, read?: any}): any;
|
{descendants, read}?: {descendants?: boolean, read?: any}): any;
|
||||||
|
@ -168,60 +196,24 @@ export interface ContentChildrenDecorator {
|
||||||
* Type of the ContentChildren metadata.
|
* Type of the ContentChildren metadata.
|
||||||
*
|
*
|
||||||
* @stable
|
* @stable
|
||||||
|
* @Annotation
|
||||||
*/
|
*/
|
||||||
export type ContentChildren = Query;
|
export type ContentChildren = Query;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @whatItDoes Configures a content query.
|
* ContentChildren decorator and metadata.
|
||||||
*
|
*
|
||||||
* @howToUse
|
* @stable
|
||||||
*
|
* @Annotation
|
||||||
* ```
|
|
||||||
* import {Directive, QueryList, ContentChildren} from '@angular/core';
|
|
||||||
*
|
|
||||||
* @Directive({
|
|
||||||
* selector: 'someDir'
|
|
||||||
* })
|
|
||||||
* class SomeDir {
|
|
||||||
* @ContentChildren(ChildDirective) contentChildren: QueryList<ChildDirective>;
|
|
||||||
*
|
|
||||||
* ngAfterContentInit() {
|
|
||||||
* // contentChildren is set
|
|
||||||
* }
|
|
||||||
* }
|
|
||||||
* ```
|
|
||||||
*
|
|
||||||
* @description
|
|
||||||
*
|
|
||||||
* You can use ContentChildren to get the {@link 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.
|
|
||||||
*
|
|
||||||
* Content queries are set before the `ngAfterContentInit` callback is called.
|
|
||||||
*
|
|
||||||
* **Metadata Properties**:
|
|
||||||
*
|
|
||||||
* * **selector** - the directive type or the name used for querying.
|
|
||||||
* * **descendants** - include only direct children or all descendants.
|
|
||||||
* * **read** - read a different token from the queried elements.
|
|
||||||
*
|
|
||||||
* Let's look at an example:
|
|
||||||
*
|
|
||||||
* {@example core/di/ts/contentChildren/content_children_example.ts region='Component'}
|
|
||||||
*
|
|
||||||
* **npm package**: `@angular/core`
|
|
||||||
*
|
|
||||||
* @stable
|
|
||||||
* @Annotation
|
|
||||||
*/
|
*/
|
||||||
export const ContentChildren: ContentChildrenDecorator = makePropDecorator(
|
export const ContentChildren: ContentChildrenDecorator =
|
||||||
'ContentChildren',
|
<ContentChildrenDecorator>makePropDecorator(
|
||||||
[
|
'ContentChildren',
|
||||||
['selector', undefined],
|
[
|
||||||
{first: false, isViewQuery: false, descendants: false, read: undefined}
|
['selector', undefined],
|
||||||
],
|
{first: false, isViewQuery: false, descendants: false, read: undefined}
|
||||||
Query);
|
],
|
||||||
|
Query);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Type of the ContentChild decorator / constructor function.
|
* Type of the ContentChild decorator / constructor function.
|
||||||
|
@ -251,20 +243,7 @@ export type ContentChild = Query;
|
||||||
*
|
*
|
||||||
* @howToUse
|
* @howToUse
|
||||||
*
|
*
|
||||||
* ```
|
* {@example core/di/ts/contentChild/content_child_howto.ts region='HowTo'}
|
||||||
* import {Directive, ContentChild} from '@angular/core';
|
|
||||||
*
|
|
||||||
* @Directive({
|
|
||||||
* selector: 'someDir'
|
|
||||||
* })
|
|
||||||
* class SomeDir {
|
|
||||||
* @ContentChild(ChildDirective) contentChild;
|
|
||||||
*
|
|
||||||
* ngAfterContentInit() {
|
|
||||||
* // contentChild is set
|
|
||||||
* }
|
|
||||||
* }
|
|
||||||
* ```
|
|
||||||
*
|
*
|
||||||
* @description
|
* @description
|
||||||
*
|
*
|
||||||
|
@ -326,21 +305,7 @@ export type ViewChildren = Query;
|
||||||
*
|
*
|
||||||
* @howToUse
|
* @howToUse
|
||||||
*
|
*
|
||||||
* ```
|
* {@example core/di/ts/viewChildren/view_children_howto.ts region='HowTo'}
|
||||||
* import {Component, QueryList, ViewChildren} from '@angular/core';
|
|
||||||
*
|
|
||||||
* @Component({
|
|
||||||
* selector: 'someCmp',
|
|
||||||
* templateUrl: 'someCmp.html'
|
|
||||||
* })
|
|
||||||
* class SomeCmp {
|
|
||||||
* @ViewChildren(ChildDirective) viewChildren: QueryList<ChildDirective>;
|
|
||||||
*
|
|
||||||
* ngAfterViewInit() {
|
|
||||||
* // viewChildren is set
|
|
||||||
* }
|
|
||||||
* }
|
|
||||||
* ```
|
|
||||||
*
|
*
|
||||||
* @description
|
* @description
|
||||||
*
|
*
|
||||||
|
@ -386,8 +351,35 @@ export const ViewChildren: ViewChildrenDecorator = makePropDecorator(
|
||||||
*/
|
*/
|
||||||
export interface ViewChildDecorator {
|
export interface ViewChildDecorator {
|
||||||
/**
|
/**
|
||||||
* @docsNotRequired
|
* @whatItDoes Configures a view query.
|
||||||
*/ (selector: Type<any>|Function|string, {read}?: {read?: any}): any;
|
*
|
||||||
|
* @howToUse
|
||||||
|
*
|
||||||
|
* {@example core/di/ts/viewChild/view_child_howto.ts region='HowTo'}
|
||||||
|
*
|
||||||
|
* @description
|
||||||
|
*
|
||||||
|
* You can use ViewChild to get the first element or the directive matching the selector from the
|
||||||
|
* view DOM. If the view DOM changes, and a new child matches the selector,
|
||||||
|
* the property will be updated.
|
||||||
|
*
|
||||||
|
* 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.
|
||||||
|
*
|
||||||
|
* Let's look at an example!!!!:
|
||||||
|
*
|
||||||
|
* {@example core/di/ts/viewChild/view_child_example.ts region='Component'}
|
||||||
|
*
|
||||||
|
* **npm package**: `@angular/core`
|
||||||
|
*
|
||||||
|
* @stable
|
||||||
|
* @Annotation
|
||||||
|
*/
|
||||||
|
(selector: Type<any>|Function|string, {read}?: {read?: any}): any;
|
||||||
new (selector: Type<any>|Function|string, {read}?: {read?: any}): ViewChild;
|
new (selector: Type<any>|Function|string, {read}?: {read?: any}): ViewChild;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -399,44 +391,7 @@ export interface ViewChildDecorator {
|
||||||
export type ViewChild = Query;
|
export type ViewChild = Query;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @whatItDoes Configures a view query.
|
* ViewChild decorator and metadata.
|
||||||
*
|
|
||||||
* @howToUse
|
|
||||||
*
|
|
||||||
* ```
|
|
||||||
* import {Component, QueryList, ViewChild} from '@angular/core';
|
|
||||||
*
|
|
||||||
* @Component({
|
|
||||||
* selector: 'someCmp',
|
|
||||||
* templateUrl: 'someCmp.html'
|
|
||||||
* })
|
|
||||||
* class SomeCmp {
|
|
||||||
* @ViewChild(ChildDirective) child: ChildDirective;
|
|
||||||
*
|
|
||||||
* ngAfterViewInit() {
|
|
||||||
* // child is set
|
|
||||||
* }
|
|
||||||
* }
|
|
||||||
* ```
|
|
||||||
*
|
|
||||||
* @description
|
|
||||||
*
|
|
||||||
* You can use ViewChild to get the first element or the directive matching the selector from the
|
|
||||||
* view DOM. If the view DOM changes, and a new child matches the selector,
|
|
||||||
* the property will be updated.
|
|
||||||
*
|
|
||||||
* 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.
|
|
||||||
*
|
|
||||||
* Let's look at an example:
|
|
||||||
*
|
|
||||||
* {@example core/di/ts/viewChild/view_child_example.ts region='Component'}
|
|
||||||
*
|
|
||||||
* **npm package**: `@angular/core`
|
|
||||||
*
|
*
|
||||||
* @stable
|
* @stable
|
||||||
* @Annotation
|
* @Annotation
|
||||||
|
|
|
@ -7,7 +7,9 @@
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Runtime representation a type that a Component or other object is instances of.
|
* @whatItDoes Represents a type that a Component or other object is instances of.
|
||||||
|
*
|
||||||
|
* @description
|
||||||
*
|
*
|
||||||
* An example of a `Type` is `MyCustomComponent` class, which in JavaScript is be represented by
|
* An example of a `Type` is `MyCustomComponent` class, which in JavaScript is be represented by
|
||||||
* the `MyCustomComponent` constructor function.
|
* the `MyCustomComponent` constructor function.
|
||||||
|
|
Loading…
Reference in New Issue