Class UrlService

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:

// Prevent $urlRouter from automatically intercepting URL changes when it starts;
urlService.deferIntercept();

$http.get('/states.json').then(function(resp) {
  resp.data.forEach(state => $stateRegistry.register(state));
  urlService.listen();
  urlService.sync();
});

If the current URL is /some/path?query=value#anchor, this returns anchor

Call this sometime after calling deferIntercept to start monitoring the url. This causes UrlRouter to start listening for changes to the URL, if it wasn't already listening.

If called with false, will stop listening. Call listen() again to start listening

Example:

urlService.deferIntercept();

$http.get('/states.json').then(function(resp) {
  resp.data.forEach(state => $stateRegistry.register(state));
  // Start responding to URL changes
  urlService.listen();
  urlService.sync();
});

inheritdoc

Example:

let deregisterFn = locationServices.onChange((evt) => console.log("url change", evt));

This method returns the current URL components as a UrlParts object.

If the current URL is /some/path?query=value#anchor, this returns /some/path

If the current URL is /some/path?query=value#anchor, this returns { query: 'value' }

Checks the current URL for a matching url rule, then invokes that rule's handler. This method is called internally any time the URL has changed.

This effectively activates the state which matches the current URL.

Example:

urlService.deferIntercept();

$http.get('/states.json').then(function(resp) {
  resp.data.forEach(state => $stateRegistry.register(state));
  urlService.listen();
  // Find the matching URL and invoke the handler.
  urlService.sync();
});

The URL is normalized using the internal path/search/hash values.

For example, the URL may be stored in the hash ([[HashLocationServices]]) or have a base HREF prepended ([[PushStateLocationServices]]).

The raw URL in the browser might be:

http://mysite.com/somepath/index.html#/internal/path/123?param1=foo#anchor

or

http://mysite.com/basepath/internal/path/123?param1=foo#anchor

then this method returns:

/internal/path/123?param1=foo#anchor

Example:

locationServices.url(); // "/some/path?query=value#anchor"

Updates the url, changing it to the value in newurl

Example:

locationServices.url("/some/path?query=value#anchor", true);