API Documentation / RouterHistory

Interface: RouterHistory

Interface implemented by History implementations that can be passed to the router as Router.history

Properties

base

• Readonly base: string

Base path that is prepended to every url. This allows hosting an SPA at a sub-folder of a domain like example.com/sub-folder by having a base of /sub-folder

---

location

• Readonly location: string

Current History location

---

state

• Readonly state: HistoryState

Current History state

Methods

createHref

▸ createHref(location): string

Generates the corresponding href to be used in an anchor tag.

Parameters

Name	Type	Description
location	string	history location that should create an href

Returns

string

---

destroy

▸ destroy(): void

Clears any event listener attached by the history implementation.

Returns

void

---

go

▸ go(delta, triggerListeners?): void

Traverses history in a given direction.

Parameters

Name	Type	Description
delta	number	distance to travel. If delta is < 0, it will go back, if it's > 0, it will go forward by that amount of entries.
triggerListeners?	boolean	whether this should trigger listeners attached to the history

Returns

void

Example

myHistory.go(-1) // equivalent to window.history.back()
myHistory.go(1) // equivalent to window.history.forward()

---

listen

▸ listen(callback): () => void

Attach a listener to the History implementation that is triggered when the navigation is triggered from outside (like the Browser back and forward buttons) or when passing true to RouterHistory.back and RouterHistory.forward

Parameters

Name	Type	Description
callback	NavigationCallback	listener to attach

Returns

fn

a callback to remove the listener

▸ (): void

Attach a listener to the History implementation that is triggered when the navigation is triggered from outside (like the Browser back and forward buttons) or when passing true to RouterHistory.back and RouterHistory.forward

Returns

void

a callback to remove the listener

---

push

▸ push(to, data?): void

Navigates to a location. In the case of an HTML5 History implementation, this will call history.pushState to effectively change the URL.

Parameters

Name	Type	Description
to	string	location to push
data?	HistoryState	optional HistoryState to be associated with the navigation entry

Returns

void

---

replace

▸ replace(to, data?): void

Same as RouterHistory.push but performs a history.replaceState instead of history.pushState

Parameters

Name	Type	Description
to	string	location to set
data?	HistoryState	optional HistoryState to be associated with the navigation entry

Returns

void