kirstein/angular-routeblocker

Angular module that helps controlling registered route triggering

angular-routeblocker

A module that makes decisive routing super easy.

Getting started

---

Add ngRouteBlocker to required modules list

    angular.module('myApp', [ …, 'ngRouteBlocker' ]);

Add block function route:

  module.config(function($routeProvider) {
    $routeProvider.when('url', {
      templateUrl : 'template.html',
      controller  : 'ControllerName',
      block      : function() {
        …
        return true;
      }
    })
  })

Whenever a $locationChangeStart event is triggered it will go through all registered routes and decide (by triggering the described block function) if we can continue with the location change or not.

In order to continue routing then the block function must return truthy values. If the block function returns truthy values then it will just continue with the routing.

If the method returns falsy result then it will cancel the location change event so it would never reach the route configuration (no template download? jay).

Multiple blocking parameters

By using $routeBlockerProvider its possible to define multiple properties to search from a route. The default property that RouteBlocker uses is block.

$routeBlockerProvider has an api that consist of three methods:

1. #getProperties returns an array of defined properties
2. #addProperty provides an easy function for adding one or multiple property names. All property names must be strings. To add multiple names at once one must pass an array of property names to #addProperty function
3. #removeProperty a way to remove property names from the list. Can be used with an array.

Dependency injection with block function

The block function works with dependency injection. It works with all three methods of dependency injection.

1. using $injector
2. using array
3. plain function injection

Devel

---

  npm install
  bower install
  grunt test
  grunt build