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.
State configuration object or array of all objects.
Absolute state name 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 stateA 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. 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 object. The options are:
location
- {boolean=true|string=} - If true
will update the url in the location bar, if false
will not. If string, must be "replace"
, which will update url and also replace last history record.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.notify
- {boolean=true}, If true
will broadcast $stateChangeStart and $stateChangeSuccess events.reload
(v0.2.5) - {boolean=false}, If true
will force transition even if the state or params
have not changed, aka a reload of the same state. It differs from reloadOnSearch because you'd
use this when you want to force a reload when everything is the same, including search params.A promise representing the state of the new transition.
Possible success values:
Possible rejection values:
event.preventDefault()
has been called in a $stateChangeStart
listenerevent.preventDefault()
has been called in a $stateNotFound
listener or
when a $stateNotFound
event.retry
promise errors.resolve
The state name or state object you'd like to generate a url from.
An object of parameter values to fill the state's required parameters.
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".compiled state url
A partial name, relative name, or glob pattern to be searched for within the current state name.
A param object, e.g. {sectionId: section.id}
,
that you'd like to test against the current active state.
An options object. The options are:
relative
- {string|object=} - If stateOrName
is a relative state reference and options.relative
is set,
.includes will test relative to options.relative
state (or name).Returns true if it does include the state
The state name (absolute or relative) or state object you'd like to check.
A param object, e.g. {sectionId: section.id}
, that you'd like
to test against the current active state.
An options object. The options are:
relative
- {string|object} - If stateOrName
is a relative state name and options.relative
is set, .is will
test relative to options.relative
state (or name).Returns true if it is the state.
A state name or a state object, which is the root of the resolves to be re-resolved.
A promise representing the state of the new transition. See {@link ui.router.state.$state#methods_go $state.go}.
Factory method for creating a TargetState
Factory method for creating a TargetState
State name.
A map of the parameters that will be sent to the state, will populate $stateParams.
Options object. The options are:
location
- {boolean=true|string=} - If true
will update the url in the location bar, if false
will not. If string, must be "replace"
, which will update url and also replace last history record.inherit
- {boolean=false}, If true
will inherit url parameters from current url.relative
- {object=}, When transitioning with relative path (e.g '^'),
defines which state to be relative from.notify
- {boolean=true}, If true
will broadcast $stateChangeStart and $stateChangeSuccess events.reload
(v0.2.5) - {boolean=false}, If true
will force transition even if the state or params
have not changed, aka a reload of the same state. It differs from reloadOnSearch because you'd
use this when you want to force a reload when everything is the same, including search params.A promise representing the state of the new transition. See {@link ui.router.state.$state#methods_go $state.go}.
Generated using TypeDoc
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.