Class UrlRouter

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();
});

Example:

matcher = $umf.compile("/about/:person");
params = { person: "bob" };
$bob = $urlRouter.href(matcher, params);
// $bob == "/about/bob";

inheritdoc

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();
});

This rule is matched when no other rule matches. It is generally used to handle unknown URLs (similar to "404" behavior, but on the client side).

• If handler a string, it is treated as a url redirect

Example:

When no other url rule matches, redirect to /index

.otherwise('/index');

• If handler is an object with a state property, the state is activated.

Example:

When no other url rule matches, redirect to home and provide a dashboard parameter value.

.otherwise({ state: 'home', params: { dashboard: 'default' } });

• If handler is a function, the function receives the current url (UrlParts) and the UIRouter object. The function can perform actions, and/or return a value.

Example:

When no other url rule matches, manually trigger a transition to the home state

.otherwise((matchValue, urlParts, router) => {
  router.stateService.go('home');
});

Example:

When no other url rule matches, go to home state

.otherwise((matchValue, urlParts, router) => {
  return { state: 'home' };
});

Pushes a new location to the browser history.

inheritdoc

Usually, a url rule is added using StateDeclaration.url or when. This api can be used directly for more control (to register a BaseUrlRule, for example). Rules can be created using UrlRouter.urlRuleFactory, or create manually as simple objects.

A rule should have a match function which returns truthy if the rule matched. It should also have a handler function which is invoked if the rule is the best match.

inheritdoc

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();
});

inheritdoc