History

The History interface of the History API allows manipulation of the browser session history, that is the pages visited in the tab or frame that the current page is loaded in.

MDN Reference

Properties

length

val length: Int

The length read-only property of the History interface returns an integer representing the number of entries in the session history, including the currently loaded page.

scrollRestoration

var scrollRestoration: ScrollRestoration

The scrollRestoration property of the History interface allows web applications to explicitly set default scroll restoration behavior on history navigation.

state

val state: JsAny?

The state read-only property of the History interface returns a value representing the state at the top of the history stack.

Functions

back

fun back()

The back() method of the History interface causes the browser to move back one page in the session history.

forward

fun forward()

The forward() method of the History interface causes the browser to move forward one page in the session history.

fun go(delta: Int = definedExternally)

The go() method of the History interface loads a specific page from the session history.

pushState

fun pushState(data: JsAny?, unused: String, url: String? = definedExternally)

The pushState() method of the History interface adds an entry to the browser's session history stack.

fun pushState(data: JsAny?, unused: String, url: URL?)

replaceState

fun replaceState(data: JsAny?, unused: String, url: String? = definedExternally)

The replaceState() method of the History interface modifies the current history entry, replacing it with the state object and URL passed in the method parameters.

fun replaceState(data: JsAny?, unused: String, url: URL?)