ui-router-navigation-location-plugin / NavigationLocationService

Class: NavigationLocationService

Defined in: index.ts:73

Location service implementation using the Navigation API.

Uses the browser's Navigation API for URL management instead of the History API, providing better integration with browser navigation and enabling interception of navigation events.

See

https://developer.mozilla.org/en-US/docs/Web/API/Navigation_API

Extends

• BaseLocationServices

Constructors

Constructor

new NavigationLocationService(router?): NavigationLocationService;

Defined in: index.ts:83

Creates a new NavigationLocationService instance.

Parameters

Parameter	Type	Description
router?	UIRouter	The UIRouter instance (required despite optional type signature)

Returns

NavigationLocationService

Throws

Error if router is not provided

Overrides

BaseLocationServices.constructor

Properties

Property	Type	Defined in
_config	LocationConfig	index.ts:74

Methods

_navigation()

protected _navigation(): Navigation;

Defined in: index.ts:113

The Navigation API object this service drives.

Single seam for every navigation touch point. Override in a subclass to substitute a stub — tests get to assert against the calls this service makes without booting a browser to spy on a global.

Returns

Navigation

Example

class StubbedNavigationLocationService extends NavigationLocationService {
  protected override _navigation(): Navigation {
    return this.stub;
  }
}

---

dispose()

dispose(router): void;

Defined in: index.ts:189

Cleans up the location service by removing the navigation event listener.

Parameters

Parameter	Type	Description
router	UIRouter	The UIRouter instance

Returns

void

Overrides

BaseLocationServices.dispose