Window: scrollBy() 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.scrollBy() method scrolls the document in thewindow by the given amount.
In this article
Syntax
scrollBy(xCoord, yCoord)scrollBy(options)Parameters
xCoordThe horizontal pixel value that you want to scroll by.
yCoordThe vertical pixel value that you want to scroll by.
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.
behaviorSpecifies whether the scrolling should animate smoothly (
smooth), happen instantly in a single jump (instant), or let the browser choose (auto, default).
Return value
None (undefined).
Examples
To scroll down one page:
window.scrollBy(0, window.innerHeight);To scroll up:
window.scrollBy(0, -window.innerHeight);Usingoptions:
window.scrollBy({ top: 100, left: 100, behavior: "smooth",});Notes
window.scrollBy() scrolls by a particular amount, whereaswindow.scroll() scrolls to an absolute position in the document. See alsowindow.scrollByLines() andwindow.scrollByPages().
Specifications
| Specification |
|---|
| CSSOM View Module> # dom-window-scrollby> |