StateService | angular-ui-router
Options
Menu

Class StateService

Provides state related service functions

This class provides services related to ui-router states. An instance of this class is located on the global UIRouter object.

Hierarchy

  • StateService

Index

Constructors

Properties

invalidCallbacks: OnInvalidCallback[] = []
router: UIRouter

Accessors

Methods

  • Handler for when transitionTo is called with an invalid state.

    Invokes the onInvalid callbacks, in natural order. Each callback's return value is checked in sequence until one of them returns an instance of TargetState. The results of the callbacks are wrapped in $q.when(), so the callbacks may return promises.

    If a callback returns an TargetState, then it is used as arguments to $state.transitionTo() and the result returned.

    Parameters

    Returns any


  • defaultErrorHandler(handler?: function): function
  • Sets or gets the default transitionTo error handler.

  • Sets or gets the default transitionTo error handler.

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

    Parameters

    • handler: Optional  function
      :

      a global error handler function

        • (error: any): void
        • Parameters

          • error any

          Returns void

    Returns function

    :

    the current global error handler

      • (error: any): void
      • Parameters

        • error any

        Returns void


  • dispose(): void
  • Transition to a different state or parameters

    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 currently active ancestor states).

    Example:

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

    Parameters

    • to StateOrName
      :

      Absolute state name, state object, or relative state path. 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
    • params: Optional  RawParams
      :

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

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

      Parameter inheritance only works between common ancestor states, I.e. transitioning to a sibling will get you the parameters for all parents, transitioning to a child will get you all current parameters, etc.

    • options: Optional  TransitionOptions
      :

      Transition options

    Returns TransitionPromise

    :

    A promise representing the state of the new transition.

    • Possible success values:

      • $state.current
    • Possible rejection reasons:

      • transition superseded - when a newer transition has been started after this one
      • transition aborted - when the transition is cancelled by a Transition Hook returning false
      • transition failed - when a transition hook errors
      • resolve error - when a resolve has errored or rejected

  • Generates a URL for a state and parameters

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

    Example:

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

    Parameters

    • stateOrName StateOrName
      :

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

    • params RawParams
      :

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

    • options: Optional  HrefOptions
      :

      Options object. The options are:

      • lossy - {boolean=true} - If true, and if there is no url associated with the state provided in the first parameter, then the constructed href url will be built from the first navigable ancestor (aka ancestor with a valid url).
      • inherit - {boolean=true}, If true will inherit url parameters from current url.
      • relative - {object=$state.$current}, When transitioning with relative path (e.g '^'), defines which state to be relative from.
      • absolute - {boolean=false}, If true will generate an absolute url, e.g. "http://www.example.com/fullurl".

    Returns string

    :

    compiled state url


  • Checks if the current state includes the provided state

    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
    

    Parameters

    • stateOrName StateOrName
      :

      A partial name, relative name, glob pattern, or state object to be searched for within the current state name.

    • params: Optional  RawParams
      :

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

    • options: Optional  TransitionOptions
      :

      An options object. The options are:

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

    Returns boolean

    :

    Returns true if it does include the state


  • is(stateOrName: StateOrName, params?: RawParams, options?: object): boolean
  • Checks if the current state is the provided state

  • Checks if the current state is the provided state

    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>
    

    Parameters

    • stateOrName StateOrName
      :

      The state name (absolute or relative) or state object you'd like to check.

    • params: Optional  RawParams
      :

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

    • options: Optional  object
      :

      An options object. The options are:

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

    Returns boolean

    :

    Returns true if it is the state.


  • Lazy loads a state

    Explicitly runs a state's StateDeclaration.lazyLoad function.

    Parameters

    • stateOrName StateOrName
      :

      the state that should be lazy loaded

    • transition: Optional  Transition
      :

      the optional Transition context to use (if the lazyLoad function requires an injector, etc) 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.

    Returns Promise<LazyLoadResult>

    :

    a promise to lazy load


  • onInvalid(callback: OnInvalidCallback): Function
  • Registers an Invalid State handler

  • Registers an Invalid State handler

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

    Parameters

    • callback OnInvalidCallback
      :

      invoked when the toState is invalid 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.

    Returns Function

    :

    a function which deregisters the callback


  • Reloads the current state

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

    Parameters

    • reloadState: Optional  StateOrName
      :

      A state name or a state object. 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');
        }
      });
      

    Returns Promise<State>

    :

    A promise representing the state of the new transition. See StateService.go


  • Low-level method for transitioning to a new state.

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

    Parameters

    • to StateOrName
      :

      State name or state object.

    • toParams: Default value  RawParams = {}
      :

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

    • options: Default value  TransitionOptions = {}
      :

      Transition options

    Returns TransitionPromise

    :

    A promise representing the state of the new transition. See go


Generated using TypeDoc