Transition.transitionoptions

The TransitionOptions object can be used to change the behavior of a transition.

It is passed as the third argument to [[$state.go]], [[$state.transitionTo]], and can be used with the [[ui-sref-opts]] directive.

Index

custom: any

You can define your own Transition Options inside this property and use them, e.g., from a Transition Hook

inherit: boolean

This option sets whether or not the transition's parameter values should be inherited from the current state parameters.

If true, it will inherit parameters from current state.
If false, only the parameters which are provided to transitionTo will be used.

location: boolean | string

This option changes how the Transition interacts with the browser's location bar (URL).

If true, it will update the url in the location bar.
If false, it will not update the url in the location bar.
If it is the string "replace", it will update the url and also replace the last history record.

notify: boolean

relative: string | StateDeclaration | State

When transitioning to relative path (e.g '^'), this option defines which state to be relative from.

reload: boolean | string | StateDeclaration | State

This option may be used to force states which are currently active to reload.

During a normal transition, a state is "retained" if:

Forcing a reload of a state will cause it to be exited and entered, which will:

Refetch that state's resolve data
Exit the state (onExit hook)
Re-enter the state (onEnter hook)
Re-render the views (controllers and templates)
When true, the destination state (and all parent states) will be reloaded.
When it is a string and is the name of a state, or when it is a State object, that state and any children states will be reloaded.