PushStateLocationService | @uirouter/react

Class PushStateLocationService

A LocationServices that gets/sets the current location using the browser's location and history apis

Uses history.pushState and history.replaceState

Hierarchy

BaseLocationServices
- PushStateLocationService

Implements

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new PushStateLocationService(router: UIRouter): PushStateLocationService

Overrides BaseLocationServices.constructor
- Defined in @uirouter/core/src/vanilla/pushStateLocationService.ts:11
Parameters
- router: UIRouter
Returns PushStateLocationService

Properties

_config

_config: LocationConfig

_history

_history: HistoryLike

_location

_location: LocationLike

fireAfterUpdate

fireAfterUpdate: boolean

Methods

Protected _get

_get(): string

Overrides BaseLocationServices._get
- Defined in @uirouter/core/src/vanilla/pushStateLocationService.ts:39
Returns string

_listener

_listener(evt: any): void

Inherited from BaseLocationServices._listener
- Defined in @uirouter/core/src/vanilla/baseLocationService.ts:13
Parameters
- evt: any
Returns void

Protected _set

_set(state: any, title: string, url: string, replace: boolean): void

Overrides BaseLocationServices._set
- Defined in @uirouter/core/src/vanilla/pushStateLocationService.ts:52
Parameters
- state: any
- title: string
- url: string
- replace: boolean
Returns void

dispose

dispose(router: UIRouter): void

Implementation of Disposable.dispose

Overrides BaseLocationServices.dispose
- Defined in @uirouter/core/src/vanilla/pushStateLocationService.ts:64
Parameters
- router: UIRouter
Returns void

hash

hash(): any

Inherited from BaseLocationServices.hash
- Defined in @uirouter/core/src/vanilla/baseLocationService.ts:47
Returns any

onChange

onChange(cb: EventListener): (Anonymous function)

Inherited from BaseLocationServices.onChange
- Defined in @uirouter/core/src/vanilla/baseLocationService.ts:63
Parameters
- cb: EventListener
Returns (Anonymous function)

path

path(): any

Inherited from BaseLocationServices.path
- Defined in @uirouter/core/src/vanilla/baseLocationService.ts:48
Returns any

search

search(): any

Inherited from BaseLocationServices.search
- Defined in @uirouter/core/src/vanilla/baseLocationService.ts:49
Returns any

url

url(url?: string, replace?: boolean): string

Inherited from BaseLocationServices.url
- Defined in @uirouter/core/src/vanilla/baseLocationService.ts:51
Parameters
- Optional url: string
- Default value replace: boolean = true
Returns string

Generated using TypeDoc