Class: History

Extends

• html.Object

Methods

append (state)

history.js:69

Appends the history by a new entry represented by a state object. Entries newer than the current entry will be lost.

Most browsers use the current document title to name the history entry.

Name	Type	Description
state	any	The history state. This may be any JSON-serializable object.

back (amount)

history.js:106

Moves the history back by the given amount of entries, which will trigger the load event with the corresponding state object.

Name	Type	Description
amount	number	(default: 1) The amount of entries to move back.

forward (amount)

history.js:124

Moves the history forward by the given amount of entries, which will trigger the load event with the corresponding state object.

Name	Type	Description
amount	number	(default: 1) The amount of entries to move forward.

replace (state)

history.js:88

Replaces the current entry of the history by a new entry represented by a state object.

Most browsers use the current document title to name the history entry.

Name	Type	Description
state	any	The history state. This may be any JSON-serializable object.

Events

html.History.event:load

history.js:47

Is triggered when a history object is to be loaded.

Name	Type	Description
state	any	A state object representing the history entry.