$state (service in module ui.router.state )

Methods

• get(stateOrName)

  Returns the state configuration object for any state by passing the name as a string. Without any arguments it'll return a array of all configured state objects.

  Parameters

  • stateOrName – {string|object} –

    The name of the state for which you'd like to get the original state configuration object for.

  Returns

  {object} –

  State configuration object or array of all objects.

• go(to, params, options)

  Convenience method for transitioning to a new state. $state.go calls $state.transitionTo internally but automatically sets options to { location: true, inherit: true, relative: $state.$current, notify: true }. This allows you to easily use an absolute or relative to path and specify only the parameters you'd like to update (while letting unspecified parameters inherit from the current state.

  Some examples:

  • $state.go('contact.detail') - will go to the contact.detail state
  • $state.go('^') - will go to a parent state
  • $state.go('^.sibling') - will go to a sibling state
  • $state.go('.child.grandchild') - will go to grandchild state

  Parameters

  • to – {string} –

    Absolute State Name or Relative State Path.

  • params – {object} –

    A map of the parameters that will be sent to the state, will populate $stateParams.

  • options – {object} –

    If Object is passed, object is an options hash.

  Example

  var app = angular.module('app', ['ui.router.state']);
  
  app.controller('ctrl', function ($scope, $state) {
    $scope.changeState = function () {
      $state.go('contact.detail');
    };
  });
  

• href(stateOrName, params)

  A url generation method that returns the compiled url for the given state populated with the given params.

  Parameters

  • stateOrName – {string|object} –

    The state name or state object you'd like to generate a url from.

  • params – {object} –

    An object of parameter values to fill the state's required parameters.

  Returns

  {string} –

  url

  Example

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

• includes(stateOrName, params)

  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.

  Parameters

  • stateOrName – {string} –

    A partial name to be searched for within the current state name.

  • params – {object} –

    A param object, e.g. {sectionId: section.id}, that you'd like to test against the current active state.

  Returns

  {boolean} –

  True or false

  Example

  $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
  

• is(stateName, params)

  Similar to $state.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.

  Parameters

  • stateName – {string|object} –

    The state name or state object you'd like to check.

  • params – {object} –

    A param object, e.g. {sectionId: section.id}, that you'd like to test against the current active state.

  Returns

  {boolean} –

  Returns true or false whether its the state or not.

  Example

  $state.is('contact.details.item'); // returns true
  $state.is(contactDetailItemStateObject); // returns true
  
  // everything else would return false
  

• reload()

  Reloads the current state by re-transitioning to it.

  Example

  var app angular.module('app', ['ui.router.state']);
  
  app.controller('ctrl', function ($state) {
    $state.reload();
  });
  

• transitionTo(to, params, options)

  Low-level method for transitioning to a new state. $state.go uses transitionTo internally. $state.go is recommended in most situations.

  Parameters

  • to – {string} –

    Absolute State Name or Relative State Path.

  • params – {object} –

    A map of the parameters that will be sent to the state, will populate $stateParams.

  • options – {object} –

    If Object is passed, object is an options hash.

  Example

  var app = angular.module('app', ['ui.router.state']);
  
  app.controller('ctrl', function ($scope, $state) {
    $scope.changeState = function () {
      $state.transitionTo('contact.detail');
    };
  });