Element.scroll()

The scroll() method of the Element interface scrolls the element to a particular set of coordinates inside a given element.

Syntax

element.scroll(x-coord, y-coord)
element.scroll(options)

Parameters

x-coord

The pixel along the horizontal axis of the element that you want displayed in the upper left.

y-coord

The pixel along the vertical axis of the element that you want displayed in the upper left.

- or -

options

A dictionary containing the following parameters:

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).

Examples

// Put the 1000th vertical pixel at the top of the element
element.scroll(0, 1000);

Using options:

element.scroll({
  top: 100,
  left: 100,
  behavior: 'smooth'
});

Specifications

Specification
CSSOM View Module (CSSOM View)
# dom-element-scroll

Browser compatibility

BCD tables only load in the browser