Class StateService

The error handler is called when a Transition is rejected or when any error occurred during the Transition. This includes errors caused by resolves and transition hooks.

Note: This handler does not receive certain Transition rejections. Redirected and Ignored Transitions are not considered to be errors by StateService.transitionTo.

The built-in default error handler logs the error to the console.

You can provide your own custom handler.

Example:

stateService.defaultErrorHandler(function() {
  // Do not log transitionTo errors
});

Returns the state declaration object for any specific state, or for all registered states.

If not provided, returns an array of ALL states.

Convenience method for transitioning to a new state.

$state.go calls $state.transitionTo internally but automatically sets options to { location: true, inherit: true, relative: router.globals.$current, notify: true }. This allows you to use either an absolute or relative to argument (because of relative: router.globals.$current). It also allows you to specify * only the parameters you'd like to update, while letting unspecified parameters inherit from the current parameter values (because of inherit: true).

Example:

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

app.controller('ctrl', function ($scope, $state) {
  $scope.changeState = function () {
    $state.go('contact.detail');
  };
});

Some examples:

• $state.go('contact.detail') - will go to the contact.detail state
• $state.go('^') - will go to the parent state
• $state.go('^.sibling') - if current state is home.child, will go to the home.sibling state
• $state.go('.child.grandchild') - if current state is home, will go to the home.child.grandchild state

Any parameters that are not specified will be inherited from current parameter values (because of inherit: true). This allows, for example, going to a sibling state that shares parameters defined by a parent state.

Returns the url for the given state populated with the given params.

Example:

expect($state.href("about.person", { person: "bob" })).toEqual("/about/bob");

A method to determine if the current active state is equal to or is the child of the state stateName. If any params are passed then they will be tested for a match as well. Not all the parameters need to be passed, just the ones you'd like to test for equality.

Example when $state.$current.name === 'contacts.details.item'

// Using partial names
$state.includes("contacts"); // returns true
$state.includes("contacts.details"); // returns true
$state.includes("contacts.details.item"); // returns true
$state.includes("contacts.list"); // returns false
$state.includes("about"); // returns false

Glob Examples when * $state.$current.name === 'contacts.details.item.url':

$state.includes("*.details.*.*"); // returns true
$state.includes("*.details.**"); // returns true
$state.includes("**.item.**"); // returns true
$state.includes("*.details.item.url"); // returns true
$state.includes("*.details.*.url"); // returns true
$state.includes("*.details.*"); // returns false
$state.includes("item.**"); // returns false

or state object to be searched for within the current state name. that you'd like to test against the current active state.

• relative: If stateOrName is a relative state name and options.relative is set, .is will test relative to options.relative state (or name).

Similar to includes but only checks for the full state name. If params is supplied then it will be tested for strict equality against the current active params object, so all params must match with none missing and no extras.

Example:

$state.$current.name = 'contacts.details.item';

// absolute name
$state.is('contact.details.item'); // returns true
$state.is(contactDetailItemStateObject); // returns true

// relative name (. and ^), typically from a template // E.g. from the 'contacts.details' template

<div ng-class="{highlighted: $state.is('.item')}">Item</div>

to test against the current active state.

• relative: If stateOrName is a relative state name and options.relative is set, .is will test relative to options.relative state (or name).

Explicitly runs a state's StateDeclaration.lazyLoad function.

Note: If no transition is provided, a noop transition is created using the from the current state to the current state. This noop transition is not actually run.

Registers a OnInvalidCallback function to be invoked when StateService.transitionTo has been called with an invalid state reference parameter

Example:

stateService.onInvalid(function(to, from, injector) {
  if (to.name() === 'foo') {
    let lazyLoader = injector.get('LazyLoadService');
    return lazyLoader.load('foo')
        .then(() => stateService.target('foo'));
  }
});

This function receives the (invalid) toState, the fromState, and an injector. The function may optionally return a TargetState or a Promise for a TargetState. If one is returned, it is treated as a redirect.

A method that force reloads the current state, or a partial state hierarchy. All resolves are re-resolved, and components reinstantiated.

Example:

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

app.controller('ctrl', function ($scope, $state) {
  $scope.reload = function(){
    $state.reload();
  }
});

Note: reload() is just an alias for:

$state.transitionTo($state.current, $state.params, {
  reload: true, inherit: false
});

If present, this state and all its children will be reloaded, but ancestors will not reload.

Example:

//assuming app application consists of 3 states: 'contacts', 'contacts.detail', 'contacts.detail.item'
//and current state is 'contacts.detail.item'
let app angular.module('app', ['ui.router']);

app.controller('ctrl', function ($scope, $state) {
  $scope.reload = function(){
    //will reload 'contact.detail' and nested 'contact.detail.item' states
    $state.reload('contact.detail');
  }
});

This is a factory method for creating a TargetState

This may be returned from a Transition Hook to redirect a transition, for example.

The go method (which uses transitionTo internally) is recommended in most situations.

Example:

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

app.controller('ctrl', function ($scope, $state) {
  $scope.changeState = function () {
    $state.transitionTo('contact.detail');
  };
});

 will populate $stateParams.