Window: scroll() method

The Window.scroll() method scrolls the window to a particular place in the document.

Syntax

js
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 smoothly
  • instant: scrolling should happen instantly in a single jump
  • auto: scroll behavior is determined by the computed value of scroll-behavior

Return value

None (undefined).

Examples

html
<!-- 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:

js
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

Browser compatibility

BCD tables only load in the browser

See also