TargetState | @uirouter/react
Options
All
  • Public
  • Public/Protected
  • All
Menu

Encapsulate the target (destination) state/params/options of a Transition.

This class is frequently used to redirect a transition to a new destination.

See:

To create a TargetState, use StateService.target.


This class wraps:

1) an identifier for a state 2) a set of parameters 3) and transition options 4) the registered state object (the StateDeclaration)

Many UI-Router APIs such as StateService.go take a StateOrName argument which can either be a state object (a StateDeclaration or StateObject) or a state name (a string). The TargetState class normalizes those options.

A TargetState may be valid (the state being targeted exists in the registry) or invalid (the state being targeted is not registered).

Hierarchy

  • TargetState

Index

Methods

$state

error

  • error(): string

exists

  • exists(): boolean

identifier

name

  • name(): string

options

params

state

toString

  • toString(): string

valid

  • valid(): boolean

withOptions

  • Returns a copy of this TargetState, using the specified Transition Options.

    Parameters

    • options: TransitionOptions

      the new options to use

    • Default value replace: boolean = false

      When false (default) the new options will be merged with the current options. When true the options will be used instead of the current options.

    Returns TargetState

withParams

  • Returns a copy of this TargetState, using the specified parameter values.

    Parameters

    • params: RawParams

      the new parameter values to use

    • Default value replace: boolean = false

      When false (default) the new parameter values will be merged with the current values. When true the parameter values will be used instead of the current values.

    Returns TargetState

withState

Static isDef

  • isDef(obj: any): obj is TargetStateDef

Generated using TypeDoc