UI-Router
About
Tutorials
Guide
API Docs
Resources
Blog
@uirouter/core/state/index | @uirouter/react
Search
Preparing search index...
The search index is not available
@uirouter/react
Options
All
Public
Public/Protected
All
Inherited
Externals
Menu
@uirouter/react
@uirouter/core/state/index
Module @uirouter/core/state/index
The state subsystem
This subsystem implements the ui-router state tree
The
StateService
has state-related service methods such as:
StateService.get
: Get a registered
StateDeclaration
object
StateService.go
: Transition from the current state to a new state
StateService.reload
: Reload the current state
StateService.target
: Get a
TargetState
(useful when redirecting from a Transition Hook)
StateService.onInvalid
: Register a callback for when a transition to an invalid state is started
StateService.defaultErrorHandler
: Register a global callback for when a transition errors
The
StateDeclaration
interface defines the shape of a state declaration
The
StateRegistry
contains all the registered states
States can be added/removed using the
StateRegistry.register
and
StateRegistry.deregister
Note: Bootstrap state registration differs by front-end framework.
Get notified of state registration/deregistration using
StateRegistry.onStatesChanged
.
Index
References
Builder
Function
Href
Options
Lazy
Load
Result
On
Invalid
Callback
Redirect
ToResult
Resolve
Types
State
Builder
State
Declaration
State
Matcher
State
Object
State
OrName
State
Queue
Manager
State
Registry
State
Registry
Listener
State
Service
Target
State
Target
State
Def
Transition
Promise
_
State
Declaration
_
View
Declaration
resolvables
Builder
References
Builder
Function
Re-exports
BuilderFunction
Href
Options
Re-exports
HrefOptions
Lazy
Load
Result
Re-exports
LazyLoadResult
On
Invalid
Callback
Re-exports
OnInvalidCallback
Redirect
ToResult
Re-exports
RedirectToResult
Resolve
Types
Re-exports
ResolveTypes
State
Builder
Re-exports
StateBuilder
State
Declaration
Re-exports
StateDeclaration
State
Matcher
Re-exports
StateMatcher
State
Object
Re-exports
StateObject
State
OrName
Re-exports
StateOrName
State
Queue
Manager
Re-exports
StateQueueManager
State
Registry
Re-exports
StateRegistry
State
Registry
Listener
Re-exports
StateRegistryListener
State
Service
Re-exports
StateService
Target
State
Re-exports
TargetState
Target
State
Def
Re-exports
TargetStateDef
Transition
Promise
Re-exports
TransitionPromise
_
State
Declaration
Re-exports
_StateDeclaration
_
View
Declaration
Re-exports
_ViewDeclaration
resolvables
Builder
Re-exports
resolvablesBuilder
UIRouter
React
Services
State
Service
State
Registry
Transition
Service
Url
Service
Url
Config
Url
Rules
Interfaces
React
State
Declaration
Components
UIRouter
UIView
UISref
UISref
Active
React
Hooks
use
Router
use
Sref
use
Sref
Active
use
Sref
Active
Exact
use
Transition
Hook
use
Current
State
And
Params
use
OnState
Changed
use
IsActive
Other
Transition
Trace
Generated using
TypeDoc
The state subsystem
This subsystem implements the ui-router state tree