Element.scrollTo()

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

Syntax

scrollTo(x-coord, y-coord)
scrollTo(options)

Parameters

  • x-coord is the pixel along the horizontal axis of the element that you want displayed in the upper left.
  • y-coord is 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).

Return value

None (undefined).

Examples

element.scrollTo(0, 1000);

Using options:

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

Specifications

Specification
Unknown specification
# dom-element-scrollto

Browser compatibility

BCD tables only load in the browser

See also