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.
The Window.scroll() method scrolls the window to a
particular place in the document.
Syntax
scroll(xCoord, yCoord)
scroll(options)
Parameters
xCoord-
The pixel along the horizontal axis of the document that you want displayed in the upper left.
yCoord-
The pixel along the vertical axis of the document that you want displayed in the upper left.
options-
An object containing the following properties:
top-
Specifies the number of pixels along the Y axis to scroll the window or element.
left-
Specifies the number of pixels along the X axis to scroll the window or element.
behavior-
Determines 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 window -->
<button onclick="scroll(0, 100);">click to scroll to the 100th pixel</button>
Using options:
window.scroll({
top: 100,
left: 100,
behavior: "smooth",
});
Notes
Window.scrollTo() is effectively the same as this method. For relative
scrolling, see Window.scrollBy(), Window.scrollByLines(),
and Window.scrollByPages().
For scrolling elements, see Element.scrollTop and
Element.scrollLeft.
Specifications
| Specification |
|---|
| CSSOM View Module # dom-window-scroll |