{{ APIRef("HTML DOM") }}
The History
interface allows to manipulate the browser session history, that is the pages visited in the tab or frame that the current page is loaded in.
Properties
The History
interface doesn't inherit any property.
- {{domxref("History.length")}} {{readOnlyInline}}
- Returns an
Integer
representing the number of elements in the session history, including the currently loaded page. For example, for a page loaded in a new tab this property returns1
. - {{domxref("History.current")}} {{readOnlyInline}} {{ non-standard_inline() }} {{ obsolete_inline(26) }}
- Returns a {{domxref("DOMString")}} representing the URL of the active item of the session history. This property was never available to web content and is no more supported by any browser. Use {{domxref("Location.href")}} instead.
- {{domxref("History.next")}} {{readOnlyInline}} {{ non-standard_inline() }} {{ obsolete_inline(26) }}
- Returns a {{domxref("DOMString")}} representing the URL of the next item in the session history. This property was never available to web content and is not supported by other browsers.
- {{domxref("History.previous")}} {{readOnlyInline}} {{ non-standard_inline() }} {{ obsolete_inline(26) }}
- Returns a {{domxref("DOMString")}} representing the URL of the previous item in the session history. This property was never available to web content and is not supported by other browsers.
- {{domxref("History.scrollRestoration")}} {{experimental_inline}}
- Allows web applications to explicitly set default scroll restoration behavior on history navigation.
- {{domxref("History.state")}} {{readOnlyInline}} {{ gecko_minversion_inline("2.0") }}
- Returns an
any
value representing the state at the top of the history stack. This is a way to look at the state without having to wait for a {{event("popstate")}} event.
Methods
The History
interface doesn't inherit any method.
- {{domxref("History.back()")}}
- Goes to the previous page in session history, the same action as when the user clicks the browser's Back button. Equivalent to
history.go(-1)
.Note: Calling this method to go back beyond the first page in the session history has no effect and doesn't raise an exception. - {{domxref("History.forward()")}}
- Goes to the next page in session history, the same action as when the user clicks the browser's Forward button; this is equivalent to
history.go(1)
.Note: Calling this method to go forward beyond the most recent page in the session history has no effect and doesn't raise an exception. - {{domxref("History.go()")}}
- Loads a page from the session history, identified by its relative location to the current page, for example
-1
for the previous page or1
for the next page. WhenintegerDelta
is out of bounds (e.g. -1 when there are no previously visited pages in the session history), the method doesn't do anything and doesn't raise an exception. Callinggo()
without parameters or with a non-integer argument has no effect (unlike Internet Explorer, which supports string URLs as the argument). - {{domxref("History.pushState()")}} {{ gecko_minversion_inline("2.0") }}
- Pushes the given data onto the session history stack with the specified title and, if provided, URL. The data is treated as opaque by the DOM; you may specify any JavaScript object that can be serialized. Note that Firefox currently ignores the title parameter; for more information, see manipulating the browser history.
Note: In Gecko 2.0 {{ geckoRelease("2.0") }} through Gecko 5.0 {{ geckoRelease("5.0") }}, the passed object is serialized using JSON. Starting in Gecko 6.0 {{ geckoRelease("6.0") }}, the object is serialized using the structured clone algorithm. This allows a wider variety of objects to be safely passed.
- {{domxref("History.replaceState()")}} {{ gecko_minversion_inline("2.0") }}
- Updates the most recent entry on the history stack to have the specified data, title, and, if provided, URL. The data is treated as opaque by the DOM; you may specify any JavaScript object that can be serialized. Note that Firefox currently ignores the title parameter; for more information, see manipulating the browser history.
Note: In Gecko 2.0 {{ geckoRelease("2.0") }} through Gecko 5.0 {{ geckoRelease("5.0") }}, the passed object is serialized using JSON. Starting in Gecko 6.0 {{ geckoRelease("6.0") }}, the object is serialized using the structured clone algorithm. This allows a wider variety of objects to be safely passed.
Specifications
Specification | Status | Comment |
---|---|---|
{{SpecName('HTML WHATWG', "browsers.html#the-history-interface", "History")}} | {{Spec2('HTML WHATWG')}} | No change from {{SpecName("HTML5 W3C")}}. |
{{SpecName('HTML5 W3C', "browsers.html#the-history-interface", "History")}} | {{Spec2('HTML5 W3C')}} | Initial definition. |
Browser compatibility
{{CompatibilityTable}}
Feature | Chrome | Firefox (Gecko) | Internet Explorer | Opera | Safari (WebKit) |
---|---|---|---|---|---|
Basic support | {{CompatVersionUnknown}} | {{CompatVersionUnknown}} | {{CompatVersionUnknown}} | {{CompatVersionUnknown}} | {{CompatVersionUnknown}} |
scrollRestoration |
{{CompatChrome(44.0)}} [1] |
Feature | Android | Android Webview | Firefox Mobile (Gecko) | IE Phone | Opera Mobile | Safari Mobile | Chrome for Android |
---|---|---|---|---|---|---|---|
Basic support | {{CompatVersionUnknown}} | {{CompatVersionUnknown}} | {{CompatVersionUnknown}} | {{CompatVersionUnknown}} | {{CompatVersionUnknown}} | {{CompatVersionUnknown}} | {{CompatVersionUnknown}} |
scrollRestoration |
{{CompatNo}} | {{CompatChrome(44.0)}} [1] | {{CompatChrome(44.0)}} [1] |
[1] Behind a flag.
See also
- The {{domxref("Window.history")}} property returning the history of the current session.