Class UrlRouterProvider

Call this method before UI-Router has bootstrapped. It will stop UI-Router from performing the initial url sync.

This can be useful to perform some asynchronous initialization before the router starts. Once the initialization is complete, call listen to tell UI-Router to start watching and synchronizing the URL.

Example:

var app = angular.module('app', ['ui.router']);

app.config(function ($urlRouterProvider) {
  // Prevent $urlRouter from automatically intercepting URL changes;
  $urlRouterProvider.deferIntercept();
})

app.run(function (MyService, $urlRouter, $http) {
  $http.get("/stuff").then(function(resp) {
    MyService.doStuff(resp.data);
    $urlRouter.listen();
    $urlRouter.sync();
  });
});

Example:

var app = angular.module('app', ['ui.router.router']);

app.config(function ($urlRouterProvider) {
  // if the path doesn't match any of the urls you configured
  // otherwise will take care of routing the user to the
  // specified url
  $urlRouterProvider.otherwise('/index');

  // Example of using function rule as param
  $urlRouterProvider.otherwise(function ($injector, $location) {
    return '/a/valid/url';
  });
});

Registers a low level url handler (a rule). A rule detects specific URL patterns and returns a redirect, or performs some action.

If a rule returns a string, the URL is replaced with the string, and all rules are fired again.

Example:

var app = angular.module('app', ['ui.router.router']);

app.config(function ($urlRouterProvider) {
  // Here's an example of how you might allow case insensitive urls
  $urlRouterProvider.rule(function ($injector, $location) {
    var path = $location.path(),
        normalized = path.toLowerCase();

    if (path !== normalized) {
      return normalized;
    }
  });
});

If the handler is a string, it is treated as a redirect, and is interpolated according to the syntax of match (i.e. like String.replace() for RegExp, or like a UrlMatcher pattern otherwise).

If the handler is a function, it is injectable. It gets invoked if $location matches. You have the option of inject the match object as $match.

The handler can return

• falsy to indicate that the rule didn't match after all, then $urlRouter will continue trying to find another one that matches.
• string which is treated as a redirect and passed to $location.url()
• void or any truthy value tells $urlRouter that the url was handled.

Example:

var app = angular.module('app', ['ui.router.router']);

app.config(function ($urlRouterProvider) {
  $urlRouterProvider.when($state.url, function ($match, $stateParams) {
    if ($state.$current.navigable !== state ||
        !equalForKeys($match, $stateParams) {
     $state.transitionTo(state, $match, false);
    }
  });
});