{{ APIRef() }}
Summary
Returns the number of pixels that the document has already been scrolled horizontally.
Syntax
var x = window.scrollX;
Parameters
- x is the number of pixels that the document is currently scrolled from the left.
Example
// If scrollX is greater than 400, reset scroll position to the top left of the document. if (window.scrollX > 400) { window.scroll(0,0); }
Notes
The pageXOffset
property is an alias for the scrollX
property:
window.pageXOffset == window.scrollX; // always true
For cross-browser compatibility, use window.pageXOffset
instead of window.scrollX
. Additionally, older versions of Internet Explorer (< 9) do not support either property and must be worked around by checking other non-standard properties. A fully compatible example:
var x = (window.pageXOffset !== undefined) ? window.pageXOffset : (document.documentElement || document.body.parentNode || document.body).scrollLeft; var y = (window.pageYOffset !== undefined) ? window.pageYOffset : (document.documentElement || document.body.parentNode || document.body).scrollTop;
Specification
Specification | Status | Comment |
---|---|---|
{{ SpecName('CSSOM View', '#dom-window-scrollx', 'window.scrollX') }} | {{ Spec2('CSSOM View') }} |
Browser compatibility
{{CompatibilityTable}}
Feature | Chrome | Firefox (Gecko) | Internet Explorer | Opera | Safari (WebKit) |
---|---|---|---|---|---|
Basic support | {{CompatVersionUnknown}} | {{CompatVersionUnknown}} | works in Edge | {{CompatVersionUnknown}} | {{CompatVersionUnknown}} |
Feature | Android | Android Webview | Firefox Mobile (Gecko) | Firefox OS | IE Mobile | Opera Mobile | Safari Mobile | Chrome for Android |
---|---|---|---|---|---|---|---|---|
Basic support | {{CompatUnknown}} | {{CompatVersionUnknown}} | {{CompatUnknown}} | {{CompatUnknown}} | {{CompatUnknown}} | {{CompatUnknown}} | {{CompatUnknown}} | {{CompatVersionUnknown}} |