cargdev/angular
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: add inpur vars doc (#27377)

Browse Source 
PR Close #27377
This commit is contained in:
Judy Bogart 2019-01-16 14:25:28 -08:00 committed by Alex Rickabaugh
parent 6c3b57a968
commit b6819fe9bb
2 changed files with 20 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
packages/common/src/directives/ng_for_of.ts
View File

@ -31,7 +31,7 @@ export class NgForOfContext<T> {
* The directive is placed on an element, which becomes the parent * The directive is placed on an element, which becomes the parent
* of the cloned templates. * of the cloned templates.
* *
* The `ngForOf` is generally used in the * The `ngForOf` directive is generally used in the
* [shorthand form](guide/structural-directives#the-asterisk--prefix) `*ngFor`. * [shorthand form](guide/structural-directives#the-asterisk--prefix) `*ngFor`.
* In this form, the template to be rendered for each iteration is the content * In this form, the template to be rendered for each iteration is the content
* of an anchor element containing the directive. * of an anchor element containing the directive.
@ -124,11 +124,19 @@ export class NgForOfContext<T> {
*/ */
@Directive({selector: '[ngFor][ngForOf]'}) @Directive({selector: '[ngFor][ngForOf]'})
export class NgForOf<T> implements DoCheck { export class NgForOf<T> implements DoCheck {
/**
* The value of the iterable expression, which can be used as a
* [template input variable](guide/structural-directives#template-input-variable).
*/
@Input() @Input()
set ngForOf(ngForOf: NgIterable<T>) { set ngForOf(ngForOf: NgIterable<T>) {
this._ngForOf = ngForOf; this._ngForOf = ngForOf;
this._ngForOfDirty = true; this._ngForOfDirty = true;
} }
/**
* A function that customizes the default tracking algorithm.
* When supplied, Angular tracks changes by the return value of the function.
*/
@Input() @Input()
set ngForTrackBy(fn: TrackByFunction<T>) { set ngForTrackBy(fn: TrackByFunction<T>) {
if (isDevMode() && fn != null && typeof fn !== 'function') { if (isDevMode() && fn != null && typeof fn !== 'function') {
@ -155,6 +163,11 @@ export class NgForOf<T> implements DoCheck {
private _viewContainer: ViewContainerRef, private _template: TemplateRef<NgForOfContext<T>>, private _viewContainer: ViewContainerRef, private _template: TemplateRef<NgForOfContext<T>>,
private _differs: IterableDiffers) {} private _differs: IterableDiffers) {}
/**
* The [template reference variable](guide/template-syntax#template-reference-variables--var-)
* for the expanded directive.
* Compare [template input variable](guide/structural-directives#template-input-variable)
*/
@Input() @Input()
set ngForTemplate(value: TemplateRef<NgForOfContext<T>>) { set ngForTemplate(value: TemplateRef<NgForOfContext<T>>) {
// TODO(TS2.1): make TemplateRef<Partial<NgForRowOf<T>>> once we move to TS v2.1 // TODO(TS2.1): make TemplateRef<Partial<NgForRowOf<T>>> once we move to TS v2.1

8
packages/core/src/change_detection/differs/iterable_differs.ts
View File

@ -117,8 +117,12 @@ export interface IterableChangeRecord<V> {
export interface CollectionChangeRecord<V> extends IterableChangeRecord<V> {} export interface CollectionChangeRecord<V> extends IterableChangeRecord<V> {}
/** /**
* An optional function passed into {@link NgForOf} that defines how to track * An optional function passed into the `NgForOf` directive that defines how to track
* items in an iterable (e.g. fby index or id) * changes for items in an iterable.
* When supplied, Angular tracks changes by the return value of the function.
* @param index The iteration index.
* @param item The item ID.
* @return The value to use for tracking changes.
* *
* @publicApi * @publicApi
*/ */