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 September 2020.

The Window.scrollBy() method scrolls the document in the window by the given amount.

Syntax

js
scrollBy(xCoord, yCoord)
scrollBy(options)

Parameters

xCoord

The horizontal pixel value that you want to scroll by.

yCoord

The vertical pixel value that you want to scroll by.

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

Specifies 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:

js
window.scrollBy(0, window.innerHeight);

To scroll up:

js
window.scrollBy(0, -window.innerHeight);

Using options:

js
window.scrollBy({
  top: 100,
  left: 100,
  behavior: "smooth",
});

Notes

window.scrollBy() scrolls by a particular amount, whereas window.scroll() scrolls to an absolute position in the document. See also window.scrollByLines() and window.scrollByPages().

Specifications

Specification
CSSOM View Module
# dom-window-scrollby

Browser compatibility

BCD tables only load in the browser