Added promises that are resolved when the menu is closed.

README.md

@@ -90,6 +90,31 @@ controller('MyCtrl', function (myOffCanvas) {
 </div>
 ```
 
+### Promises
+
+When the menu is opened with toggle(), it will return a promise that is resolved when the menu is closed.
+
+```javascript
+myOffCanvas.toggle()
+  .then(function() {
+    console.log('The menu has been closed!');
+  });
+
+myOffCanvas.toggle(); // The menu will close and display the message.
+```
+
+If the menu is already opened, then the promise will be immediately rejected.
+
+```javascript
+myOffCanvas.toggle(); // The menu will open and nothing will be displayed in the console.
+myOffCanvas.toggle()
+  .then(function() {
+    console.log('The menu has been closed!');
+  }, function() {
+    console.log('The menu was already opened.');
+  }); // The menu will close and the message "The menu was already open" will be displayed immediately.
+```
+
 
 ## API
 
@@ -136,7 +161,8 @@ A `navService` has just two methods: `activate` and `deactivate`.
 
 #### `navService.toggle`
 
-Add or remove a class to open/hide the nav with CSS
+Add or remove a class to open/hide the nav with CSS.
+Returns a promise that will be resolved when the off canvas menu closes, or is immediately rejected if the toggle closes an already opened menu.
 
 ## Tests
 

off-canvas.js

@@ -19,6 +19,7 @@ angular.module('cn.offCanvas', [])
 				controller = config.controller || angular.noop,
 				controllerAs = config.controllerAs,
 				element = null,
+				promise = null,
 				html;
 
 			if(config.template) {
@@ -45,13 +46,38 @@ angular.module('cn.offCanvas', [])
 			})
 
 			function toggle() {
-				this.isOpened = !this.isOpened;
-				container.toggleClass(containerClass);
+				if (this.isOpened) {
+					return this.close();
+				} else {
+					return this.open();
+				}
+			}
+
+			function open() {
+				if (!this.isOpened) {
+					this.isOpened = true;
+					container.toggleClass(containerClass);
+				}
+				promise = $q.defer();
+				return promise.promise;
+			}
+
+			function close() {
+				if (this.isOpened) {
+					this.isOpened = false;
+					container.toggleClass(containerClass);
+				}
+				promise.resolve();
+				var defered = $q.defer();
+				defered.reject();
+				return defered.promise;
 			}
 
 			return {
 				toggle: toggle,
+				open: open,
+				close: close,
 				isOpened: false
 			}
 		}
-	});
+	});

off-canvas.spec.js

@@ -111,4 +111,44 @@ describe('cnOffCanvas', function() {
       expect(container.hasClass('is-opened-nav')).toBeTruthy();
     });
   });
+
+  describe('promises', function() {
+    var offCanvas;
+    beforeEach(function() {
+      offCanvas = cnOffCanvas({
+        templateUrl: 'test.html',
+        container: container
+      });
+    });
+    it('should be created on toggle', function() {
+      var promise = offCanvas.toggle();
+      expect(promise).toBeDefined();
+      promise = offCanvas.toggle();
+      expect(promise).toBeDefined();
+    });
+
+    it('should be resolved after closed', inject(function($rootScope) {
+      var resolved = false;
+      offCanvas.toggle()
+        .then(function() {
+          resolved = true;
+        });
+      expect(resolved).toBe(false);
+      offCanvas.toggle();
+      $rootScope.$apply();
+      expect(resolved).toBe(true);
+    }));
+
+    it('should be rejected if the toggle closes', inject(function($rootScope) {
+      offCanvas.toggle();
+      var result = "nothing";
+      offCanvas.toggle()
+        .then(function() {
+          resolved = "success";
+        }, function() {
+          resolved = "rejected";
+        });
+        expect(resolved).toBe("rejected");
+    }));
+  });
 });