Element: scroll() method

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

Syntax

scroll(xCoord, yCoord)
scroll(options)

Parameters

xCoord

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

yCoord

The pixel along the vertical axis of the element 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

// 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

Browser compatibility