$urlRouter

service in module ui.router.router

Methods

• href(urlMatcher, params, options)

  A URL generation method that returns the compiled URL for a given UrlMatcher, populated with the provided parameters.

  Parameters

  Param	Type	Details
  urlMatcher	UrlMatcher	The UrlMatcher object which is used as the template of the URL to generate.
  params (optional)	object	An object of parameter values to fill the matcher's required parameters.
  options (optional)	object	Options object. The options are: absolute - {boolean=false}, If true will generate an absolute url, e.g. "http://www.example.com/fullurl".

  Returns

  string

  Returns the fully compiled URL, or null if params fail validation against urlMatcher

  Example

  $bob = $urlRouter.href(new UrlMatcher("/about/:person"), {
    person: "bob"
  });
  // $bob == "/about/bob";
  

• sync()

  Triggers an update; the same update that happens when the address bar url changes, aka $locationChangeSuccess. This method is useful when you need to use preventDefault() on the $locationChangeSuccess event, perform some custom logic (route protection, auth, config, redirection, etc) and then finally proceed with the transition by calling $urlRouter.sync().

  Example

  angular.module('app', ['ui.router'])
    .run(function($rootScope, $urlRouter) {
      $rootScope.$on('$locationChangeSuccess', function(evt) {
        // Halt state change from even starting
        evt.preventDefault();
        // Perform custom logic
        var meetsRequirement = ...
        // Continue with the update and state transition if logic allows
        if (meetsRequirement) $urlRouter.sync();
      });
  });