DevExtreme widgets should render templates within Angular Zone (#882) (…

…#883) DevExtreme widgets should render templates within Angular Zone (#882)
DevExpress · Oct 25, 2018 · d8f4ae0 · d8f4ae0
1 parent 1a802cf
commit d8f4ae0
Show file tree

Hide file tree

Showing 2 changed files with 64 additions and 12 deletions.
diff --git a/src/core/template.ts b/src/core/template.ts
@@ -6,7 +6,9 @@ import {
     TemplateRef,
     ViewContainerRef,
     Input,
-    Renderer2
+    Renderer2,
+    NgZone,
+    EmbeddedViewRef
 } from '@angular/core';
 
 import { DxTemplateHost } from './template-host';
@@ -34,25 +36,41 @@ export class DxTemplateDirective {
     constructor(private templateRef: TemplateRef<any>,
         private viewContainerRef: ViewContainerRef,
         templateHost: DxTemplateHost,
-        private renderer: Renderer2) {
+        private renderer: Renderer2,
+        private zone: NgZone) {
         templateHost.setTemplate(this);
     }
 
-    render(renderData: RenderData) {
-        let childView = this.viewContainerRef.createEmbeddedView(this.templateRef, {
+    private renderTemplate(renderData: RenderData): EmbeddedViewRef<any> {
+        const childView = this.viewContainerRef.createEmbeddedView(this.templateRef, {
             '$implicit': renderData.model,
             index: renderData.index
         });
-        let container = getElement(renderData.container);
+
+        const container = getElement(renderData.container);
         if (renderData.container) {
             childView.rootNodes.forEach((element) => {
                 this.renderer.appendChild(container, element);
             });
         }
-        // =========== WORKAROUND =============
-        // https://github.com/angular/angular/issues/12243
-        childView['detectChanges']();
-        // =========== /WORKAROUND =============
+
+        return childView;
+    }
+
+    render(renderData: RenderData) {
+        let childView;
+        if (this.zone.isStable) {
+            childView = this.zone.run(() => {
+                return this.renderTemplate(renderData);
+            });
+        } else {
+            childView = this.renderTemplate(renderData);
+            // =========== WORKAROUND =============
+            // https://github.com/angular/angular/issues/12243
+            childView['detectChanges']();
+            // =========== /WORKAROUND =============
+        }
+
         childView.rootNodes.forEach((element) => {
             if (element.nodeType === 1) {
                 this.renderer.addClass(element, DX_TEMPLATE_WRAPPER_CLASS);

diff --git a/tests/src/core/template.spec.ts b/tests/src/core/template.spec.ts
@@ -93,13 +93,21 @@ export class DxTestComponent extends DxComponent implements AfterViewInit {
         return new DxTestWidget(element, options);
     }
 
-    ngAfterViewInit() {
+    renderTemplate(model) {
+        const element = this.element.nativeElement;
+        element.textContent = '';
         this.templates[0].render({
-            model: {},
-            container: this.element.nativeElement,
+            model: model,
+            container: element,
             index: 5
         });
     }
+
+    ngAfterViewInit() {
+        this.renderTemplate({
+            value: () => ''
+        });
+    }
 }
 
 @Component({
@@ -109,6 +117,7 @@ export class DxTestComponent extends DxComponent implements AfterViewInit {
 })
 export class TestContainerComponent {
     @ViewChild(DxTestWidgetComponent) widget: DxTestWidgetComponent;
+    @ViewChild(DxTestComponent) testComponent: DxTestComponent;
 
     @Output() onInnerElementClicked = new EventEmitter<any>();
 
@@ -193,5 +202,30 @@ describe('DevExtreme Angular widget\'s template', () => {
         expect(element.textContent).toBe('index: 5');
     });
 
+    it('should be created within Angular Zone', () => {
+        TestBed.overrideComponent(TestContainerComponent, {
+            set: {
+                template: `
+            <dx-test>
+                <div *dxTemplate="let d of 'templateName'">
+                    <div class="elem" (click)="d.value()"></div>
+                </div>
+            </dx-test>
+           `}
+        });
+
+        let fixture = TestBed.createComponent(TestContainerComponent);
+        fixture.detectChanges();
+
+        fixture.ngZone.runOutsideAngular(() => {
+            fixture.componentInstance.testComponent.renderTemplate({
+                value: () => {
+                    expect(fixture.ngZone.isStable).toBe(false);
+                }
+            });
+        });
+
+        fixture.nativeElement.querySelector('.elem').click();
+    });
 });