state

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 popstate event.

Syntax

let currentState = history.state;

The value of the state property is null until you call pushState() or replaceState().

Examples

This logs the value of history.state before using the pushState() method to push a value to the history. The next line logs the value to the console again, showing that history.state now has a value. You can run this lines in a script file, or execute them one at a time in the Console.

// Should be null because we haven't modified the history stack yet
console.log(`History.state before pushState: ${history.state}`);

// Now push something on the stack
history.replaceState({name: 'Example'}, "pushState example", 'page3.html');

// Now state has a value.
console.log(`History.state after pushState: ${history.state}`);

SpecificationsE

Specification Status Comment
HTML Living Standard
The definition of 'History' in that specification.
Living Standard Adds the scrollRestoration attribute.
HTML5
The definition of 'History' in that specification.
Recommendation Initial definition.
Custom Scroll Restoration - History-based API
The definition of 'History' in that specification.
Draft Adds the scrollRestoration attribute.

Browser compatibility

Update compatibility data on GitHub
DesktopMobile
ChromeEdgeFirefoxInternet ExplorerOperaSafariAndroid webviewChrome for AndroidFirefox for AndroidOpera for AndroidSafari on iOSSamsung Internet
stateChrome Full support YesEdge Full support 12Firefox Full support YesIE Full support 10Opera Full support YesSafari Full support YesWebView Android Full support YesChrome Android Full support YesFirefox Android Full support YesOpera Android Full support YesSafari iOS Full support YesSamsung Internet Android ?

Legend

Full support Ā 
Full support
Compatibility unknown Ā 
Compatibility unknown

See also