Window: scroll() method
Baseline Widely available
This feature is well established and works across many devices and browser versions. It’s been available across browsers since July 2015.
TheWindow.scroll() method scrolls the window to aparticular place in the document.
Syntax
scroll(xCoord, yCoord)scroll(options)Parameters
xCoordThe pixel along the horizontal axis of the document that youwant displayed in the upper left.
yCoordThe pixel along the vertical axis of the document that youwant displayed in the upper left.
optionsAn object containing the following properties:
topSpecifies the number of pixels along the Y axis to scroll the window or element.
leftSpecifies the number of pixels along the X axis to scroll the window or element.
behaviorDetermines whether scrolling is instant or animates smoothly. This option is a string which must take one of the following values:
smooth: scrolling should animate smoothlyinstant: scrolling should happen instantly in a single jumpauto: scroll behavior is determined by the computed value ofscroll-behavior
Return value
None (undefined).
Examples
// Put the 100th vertical pixel at the top of the windowwindow.scroll(0, 100);Usingoptions:
window.scroll({ top: 100, left: 100, behavior: "smooth",});Notes
Window.scrollTo() is effectively the same as this method. For relativescrolling, seeWindow.scrollBy(),Window.scrollByLines(),andWindow.scrollByPages().
For scrolling elements, seeElement.scrollTop andElement.scrollLeft.
Specifications
| Specification |
|---|
| CSSOM View Module # dom-window-scroll |