feat: add isActive(name, params) function

bower.json

@@ -1,6 +1,6 @@
 {
   "name": "router5",
-  "version": "0.1.0-rc.3",
+  "version": "0.1.0-rc.4",
   "homepage": "http://router5.github.io",
   "authors": [
     "Thomas Roch <thomas.c.roch@gmail.com>"

dist/browser/router5.js

@@ -649,6 +649,20 @@ var Router5 = (function () {
             // return window.history.state
             ;
         }
+    }, {
+        key: 'isActive',
+
+        /**
+         * Whether or not the given route name with specified params is active.
+         * @param  {String}  name        The route name
+         * @param  {Object}  [params={}] The route parameters
+         * @return {Boolean}             Whether nor not the route is active
+         */
+        value: function isActive(name) {
+            var params = arguments[1] === undefined ? {} : arguments[1];
+
+            return this.areStatesEqual(makeState(name, params), this.getState());
+        }
     }, {
         key: 'getWindowPath',
 

dist/commonjs/router5.js

@@ -210,6 +210,20 @@ var Router5 = (function () {
             // return window.history.state
             ;
         }
+    }, {
+        key: 'isActive',
+
+        /**
+         * Whether or not the given route name with specified params is active.
+         * @param  {String}  name        The route name
+         * @param  {Object}  [params={}] The route parameters
+         * @return {Boolean}             Whether nor not the route is active
+         */
+        value: function isActive(name) {
+            var params = arguments[1] === undefined ? {} : arguments[1];
+
+            return this.areStatesEqual(makeState(name, params), this.getState());
+        }
     }, {
         key: 'getWindowPath',
 

dist/umd/router5.js

@@ -217,6 +217,20 @@
                 // return window.history.state
                 ;
             }
+        }, {
+            key: 'isActive',
+
+            /**
+             * Whether or not the given route name with specified params is active.
+             * @param  {String}  name        The route name
+             * @param  {Object}  [params={}] The route parameters
+             * @return {Boolean}             Whether nor not the route is active
+             */
+            value: function isActive(name) {
+                var params = arguments[1] === undefined ? {} : arguments[1];
+
+                return this.areStatesEqual(makeState(name, params), this.getState());
+            }
         }, {
             key: 'getWindowPath',
 

modules/Router5.js

@@ -165,6 +165,16 @@ export default class Router5 {
         // return window.history.state
     }
 
+    /**
+     * Whether or not the given route name with specified params is active.
+     * @param  {String}  name        The route name
+     * @param  {Object}  [params={}] The route parameters
+     * @return {Boolean}             Whether nor not the route is active
+     */
+    isActive(name, params = {}) {
+        return this.areStatesEqual(makeState(name, params), this.getState())
+    }
+
     /**
      * @private
      */

package.json

@@ -1,6 +1,6 @@
 {
   "name": "router5",
-  "version": "0.1.0-rc.3",
+  "version": "0.1.0-rc.4",
   "description": "An HTML5 router, based on route-node and path-parser",
   "main": "dist/commonjs/index.js",
   "scripts": {

tests/main.js

@@ -214,5 +214,16 @@ describe('router5', function () {
         router.registerComponent('users.view', {});
         expect(console.warn).toHaveBeenCalled();
     });
+
+    it('should tell if a route is active or not', function () {
+        router.navigate('users.view', {id: 1});
+        expect(router.isActive('users.view', {id: 1})).toBe(true);
+        expect(router.isActive('users.view', {id: 2})).toBe(false);
+        expect(router.isActive('users.view')).toBe(false);
+
+        router.navigate('users');
+        expect(router.isActive('users')).toBe(true);
+        expect(router.isActive('users', {})).toBe(true);
+    });
 });