Creates a new Transition object.
Creates a new Transition object.
If the target state is not valid, an error is thrown.
The path of Nodes from which the transition is leaving. The last node in the fromPath
encapsulates the "from state".
The target state and parameters being transitioned to (also, the transition options)
The Transition Service instance
The Transition Service instance
Registers a callback function as an onBefore Transition Hook
The hook is only registered for this specific Transition. For global hooks, use TransitionService.onBefore
Registers a callback function as an onEnter State Hook
The hook is only registered for this specific Transition. For global hooks, use TransitionService.onEnter
Registers a callback function as an onError Transition Hook
The hook is only registered for this specific Transition. For global hooks, use TransitionService.onError
Registers a callback function as an onExit State Hook
The hook is only registered for this specific Transition. For global hooks, use TransitionService.onExit
Registers a callback function as an onFinish Transition Hook
The hook is only registered for this specific Transition. For global hooks, use TransitionService.onFinish
Registers a callback function as an onRetain State Hook
The hook is only registered for this specific Transition. For global hooks, use TransitionService.onRetain
Registers a callback function as an onStart Transition Hook
The hook is only registered for this specific Transition. For global hooks, use TransitionService.onStart
Registers a callback function as an onSuccess Transition Hook
The hook is only registered for this specific Transition. For global hooks, use TransitionService.onSuccess
This promise is resolved or rejected based on the outcome of the Transition.
When the transition is successful, the promise is resolved When the transition is unsuccessful, the promise is rejected with the [[TransitionRejection]] or javascript error
Adds new resolves to this transition.
Adds new resolves to this transition.
an [[ResolveDeclarations]] object which describes the new resolves
the state in the "to path" which should receive the new resolves (otherwise, the root state)
Returns true if the transition is dynamic.
Returns true if the transition is dynamic.
A transition is dynamic if no states are entered nor exited, but at least one dynamic parameter has changed.
true if the Transition is dynamic
Gets the states being entered.
Gets the states being entered.
an array of states that will be entered during this transition.
The reason the Transition is invalid
The reason the Transition is invalid
an error message explaining why the transition is invalid
Gets the states being exited.
Gets the states being exited.
an array of states that will be exited during this transition.
Returns the "from state"
Returns the "from state"
The state object for the Transition's "from state".
Returns true if the transition is ignored.
Returns true if the transition is ignored.
A transition is ignored if no states are entered nor exited, and no parameter values have changed.
true if the Transition is ignored.
Determines whether two transitions are equivalent.
Determines whether two transitions are equivalent.
Get the transition options
Get the transition options
the options for this Transition.
Gets transition parameter values
Gets transition parameter values
Pick which treeChanges path to get parameters for:
('to', 'from', 'entering', 'exiting', 'retained')
transition parameter values for the desired path.
Gets the previous transition, from which this transition was redirected.
Gets the previous transition, from which this transition was redirected.
The previous Transition, or null if this Transition is not the result of a redirection
Returns a new Transition instance.
Get resolved data
Get resolved data
an object (key/value pairs) where keys are resolve names and values are any settled resolve data,
or undefined for pending resolve data
Gets the states being retained.
Gets the states being retained.
an array of states that are already entered from a previous Transition, that will not be exited during this Transition
Runs the transition
Runs the transition
This method is generally called from the StateService.transitionTo
a promise for a successful transition.
Returns the "to state"
Returns the "to state"
The state object for the Transition's target state ("to state").
A string representation of the Transition
A string representation of the Transition
A string representation of the Transition
Checks if the Transition is valid
Checks if the Transition is valid
true if the Transition is valid
Get the ViewConfigs associated with this Transition
Get the ViewConfigs associated with this Transition
Each state can define one or more views (template/controller), which are encapsulated as ViewConfig objects.
This method fetches the ViewConfigs for a given path in the Transition (e.g., "to" or "entering").
the name of the path to fetch views for:
('to', 'from', 'entering', 'exiting', 'retained')
If provided, only returns the ViewConfigs for a single state in the path
a list of ViewConfig objects for the given path.
Generated using TypeDoc
The representation of a transition between two states.
Contains all contextual information about the to/from states, parameters, resolves, as well as the list of states being entered and exited as a result of this transition.