W3cubDocs

/Web APIs

Window: scrollY property

The read-only scrollY property of the Window interface returns the number of pixels that the document is currently scrolled vertically.

This value is subpixel precise in modern browsers, meaning that it isn't necessarily a whole number. You can get the number of pixels the document is scrolled horizontally from the scrollX property.

Value

In practice, the returned value is a double-precision floating-point value with the range of 2^(-1022) to 2^(+1023). It indicates the number of pixels the document is currently scrolled vertically from the origin, where a positive value means the content is scrolled to upward. If the document is rendered on a subpixel-precise device, then the returned value is also subpixel-precise and may contain a decimal component. If the document isn't scrolled at all up or down, then scrollY is 0.

Note: If you need an integer value, you can use Math.round() to round it off.

In more technical terms, scrollY returns the Y coordinate of the top edge of the current viewport. If there is no viewport, the returned value is 0.

Examples

js

// make sure and go down to the second page
if (window.scrollY) {
  window.scroll(0, 0); // reset the scroll position to the top left of the document.
}

window.scrollByPages(1);

Notes

Use this property to check that the document hasn't already been scrolled when using relative scroll functions such as scrollBy(), scrollByLines(), or scrollByPages().

The pageYOffset property is an alias for the scrollY property:

js

window.pageYOffset === window.scrollY; // always true

Specifications

Specification
CSSOM View Module
# dom-window-scrolly

Browser compatibility

Desktop Mobile
Chrome Edge Firefox Internet Explorer Opera Safari WebView Android Chrome Android Firefox for Android Opera Android Safari on IOS Samsung Internet
scrollY 11 1212 11 9 9.64 11 4.44.4 1818 44 10.110.1 11 1.01.0
subpixel_precision 40 ≤18 55 No 27 No 40 40 55 27 No 4.0

See also

© 2005–2023 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/Window/scrollY