Merge pull request #237 from biig-io/feature/close-all-modals

Add close all modals feature, and add documentation about it

Author: marco10024

src/app/doc/parts/api/api.component.ts

@@ -90,6 +90,14 @@ export class AppComponent {
         type: 'void'
       }
     },
+    {
+      name: ['closeAll()'],
+      description: 'Close all opened modals',
+      params: [],
+      return: {
+        type: 'void'
+      }
+    },
     {
       name: ['toggle(id: string, force?: boolean)'],
       description: 'Toggle (open <strong>or</strong> close) a given modal',

src/ngx-smart-modal/src/services/ngx-smart-modal.service.ts

@@ -83,6 +83,15 @@ export class NgxSmartModalService {
     return this._closeModal(this.get(id));
   }
 
+  /**
+   * Close all opened modals
+   */
+  public closeAll(): void {
+    this.getOpenedModals().forEach((instance: ModalInstance) => {
+      this._closeModal(instance.modal);
+    });
+  }
+
   /**
    * Toggles a given modal
    * If the retrieved modal is opened it closes it, else it opens it.

src/ngx-smart-modal/tests/services/ngx-smart-modal.service.spec.ts

@@ -91,7 +91,7 @@ describe('NgxSmartModalService', () => {
 
   it('should add events ( _private and no browser )', inject([NgxSmartModalService], (service: NgxSmartModalService) => {
     spyOnProperty(service as any, 'isBrowser', 'get').and.returnValue(false);
-    
+
     expect((service as any)._addEvents()).toBeFalsy();
   }));
 
@@ -413,4 +413,48 @@ describe('NgxSmartModalService', () => {
     tick(500);
     expect((service as any)._trapFocusModal(event)).toBeFalsy();
   })));
+
+  it('should closeAll', fakeAsync(inject([NgxSmartModalService], (service: NgxSmartModalService) => {
+    const firstFixture = TestBed.createComponent(NgxSmartModalComponent);
+    const secFixture = TestBed.createComponent(NgxSmartModalComponent);
+    const thirdFixture = TestBed.createComponent(NgxSmartModalComponent);
+    const firstApp = firstFixture.debugElement.componentInstance;
+    const secApp = secFixture.debugElement.componentInstance;
+    const thirdApp = thirdFixture.debugElement.componentInstance;
+
+    firstApp.identifier = 'myFirstModal';
+    secApp.identifier = 'mySecModal';
+    thirdApp.identifier = 'myThirdModal';
+
+    service.addModal({ id: 'myFirstModal', modal: firstApp });
+    service.addModal({ id: 'mySecModal', modal: secApp });
+    service.addModal({ id: 'myThirdModal', modal: thirdApp });
+
+    spyOn(service, 'closeAll').and.callThrough();
+    spyOn(service, 'getOpenedModals').and.callThrough();
+    spyOn(service as any, '_closeModal').and.callThrough();
+
+    service.open(firstApp.identifier);
+    service.open(secApp.identifier);
+    service.open(thirdApp.identifier);
+
+    expect(firstApp.visible).toBeTruthy();
+    expect(secApp.visible).toBeTruthy();
+    expect(thirdApp.visible).toBeTruthy();
+
+    tick(501);
+
+    service.closeAll();
+
+    tick(501);
+
+    expect(service.closeAll).toHaveBeenCalled();
+    expect(service.getOpenedModals).toHaveBeenCalled();
+    expect(service['_closeModal']).toHaveBeenCalledWith(firstApp);
+    expect(service['_closeModal']).toHaveBeenCalledWith(secApp);
+    expect(service['_closeModal']).toHaveBeenCalledWith(thirdApp);
+    expect(firstApp.visible).toBeFalsy();
+    expect(secApp.visible).toBeFalsy();
+    expect(thirdApp.visible).toBeFalsy();
+  })));
 });