Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(common): better error message when non-template element used in NgIf #22274

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
11 changes: 10 additions & 1 deletion packages/common/src/directives/ng_if.ts
Expand Up @@ -6,7 +6,7 @@
* found in the LICENSE file at https://angular.io/license
*/

import {Directive, EmbeddedViewRef, Input, TemplateRef, ViewContainerRef} from '@angular/core';
import {Directive, EmbeddedViewRef, Input, TemplateRef, ViewContainerRef, ɵstringify as stringify} from '@angular/core';


/**
Expand Down Expand Up @@ -118,13 +118,15 @@ export class NgIf {

@Input()
set ngIfThen(templateRef: TemplateRef<NgIfContext>) {
assertTemplate('ngIfThen', templateRef);
this._thenTemplateRef = templateRef;
this._thenViewRef = null; // clear previous view if any.
this._updateView();
}

@Input()
set ngIfElse(templateRef: TemplateRef<NgIfContext>) {
assertTemplate('ngIfElse', templateRef);
this._elseTemplateRef = templateRef;
this._elseViewRef = null; // clear previous view if any.
this._updateView();
Expand Down Expand Up @@ -163,3 +165,10 @@ export class NgIfContext {
public $implicit: any = null;
public ngIf: any = null;
}

function assertTemplate(property: string, templateRef: TemplateRef<any>): void {
const isTemplateRef = templateRef.createEmbeddedView != null;
if (!isTemplateRef) {
throw new Error(`${property} must be a TemplateRef, but received '${stringify(templateRef)}'.`);
}
}
22 changes: 22 additions & 0 deletions packages/common/test/directives/ng_if_spec.ts
Expand Up @@ -217,6 +217,28 @@ import {expect} from '@angular/platform-browser/testing/src/matchers';
expect(fixture.nativeElement).toHaveText('false');
}));
});

describe('Type guarding', () => {
it('should throw when then block is not template', async(() => {
const template = '<span *ngIf="booleanCondition; then thenBlock">IGNORE</span>' +
'<div #thenBlock>THEN</div>';

fixture = createTestComponent(template);

expect(() => fixture.detectChanges())
.toThrowError(/ngIfThen must be a TemplateRef, but received/);
}));

it('should throw when else block is not template', async(() => {
const template = '<span *ngIf="booleanCondition; else elseBlock">IGNORE</span>' +
'<div #elseBlock>ELSE</div>';

fixture = createTestComponent(template);

expect(() => fixture.detectChanges())
.toThrowError(/ngIfElse must be a TemplateRef, but received/);
}));
});
});
}

Expand Down