Introduce new option, closeOn, to override $locationChangeSuccess.

README.md

@@ -142,6 +142,7 @@ The `showModal` function takes an object with these fields:
 * `scope`: Optional. If provided, the modal controller will use a new scope as a child of `scope` (created by calling `scope.$new()`) rather than a new scope created as a child of `$rootScope`.
 * `bodyClass`: Optional. The custom css class to append to the body while the modal is open (optional, useful when not using Bootstrap).
 * `preClose`: Optional. A function which will be called before the process of closing a modal starts. The signature is `function preClose(modal, result, delay)`. It is provided the `modal` object, the `result` which was passed to `close` and the `delay` which was passed to close.
+* `closeOn`: A $rootScope event which will close the modal. The default value is `$locationChangeSuccess`. A value of `false` can be passed instead of an event to turn this feature off.
 
 #### The Modal Object
 

src/angular-modal-service.js

@@ -72,10 +72,16 @@ module.factory('ModalService', ['$animate', '$document', '$compile', '$controlle
 
           //  The main modal object we will build.
           var modal = {};
+          var rootScopeOnClose;
 
           //  Create a new scope for the modal.
           var modalScope = (options.scope || $rootScope).$new();
-          var rootScopeOnClose = $rootScope.$on('$locationChangeSuccess', cleanUpClose);
+
+          !options.hasOwnProperty('closeOn') && (options.closeOn = '$locationChangeSuccess');
+
+          if (options.closeOn !== false) {
+            rootScopeOnClose = $rootScope.$on(options.closeOn, cleanUpClose);
+          }
 
           //  Create the inputs object to the controller - this will include
           //  the scope, as well as all inputs provided.
@@ -184,7 +190,7 @@ module.factory('ModalService', ['$animate', '$document', '$compile', '$controlle
                     });
 
             // remove event watcher
-            rootScopeOnClose && rootScopeOnClose();
+            !!rootScopeOnClose && rootScopeOnClose();
           }
 
         })

test/dom.spec.js

@@ -120,23 +120,47 @@ describe('dom', () => {
 
   });
 
-  it('should remove the template html from the dom when the $locationChangeSuccess event is fired', () => {
+  it('should remove the template html from the dom when the onClose $rootScope event is fired', () => {
 
     $httpBackend.expectGET('some/template2.html');
 
     ModalService.showModal({
       controller: "DomController",
-      templateUrl: "some/template2.html"
+      templateUrl: "some/template2.html",
+      closeOn: "$locationChangeSuccess"
+    }).then((modal) => {
+
+      // We should be able to find the element that has been created in the dom.
+      expect(document.getElementById('template2')).not.toBeNull();
+      $rootScope.$emit('$locationChangeSuccess');
+      expect(document.getElementById('template2')).toBeNull();
+
+    });
+
+    $httpBackend.flush();
+    $timeout.flush();
+
+  });
+
+  it('should NOT remove the template html from the dom if false is passed to onClose', () => {
+
+    $httpBackend.expectGET('some/template2.html');
+
+    ModalService.showModal({
+      controller: "DomController",
+      templateUrl: "some/template2.html",
+      closeOn: false
     }).then((modal) => {
 
       // We should be able to find the element that has been created in the dom.
       expect(document.getElementById('template2')).not.toBeNull();
+      $rootScope.$emit('$locationChangeSuccess');
+      expect(document.getElementById('template2')).not.toBeNull();
 
       modal.close.then((result) => {
         expect(document.getElementById('template2')).toBeNull();
       });
 
-      $rootScope.$emit('$locationChangeSuccess');
     });
 
     $httpBackend.flush();