W3cubDocs

/Web APIs

Element: scrollTo() method

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

Syntax

js

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

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

js

element.scrollTo(0, 1000);

Using options:

js

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

Specifications

Specification
CSSOM View Module
# dom-element-scrollto

Browser compatibility

Desktop Mobile
Chrome Edge Firefox Internet Explorer Opera Safari WebView Android Chrome Android Firefox for Android Opera Android Safari on IOS Samsung Internet
scrollTo 61 79 36 No 48 10.1 61 61 36 45 10.3 8.0
options_behavior_parameter 61 79 36 No 48 14 61 61 36 45 14 8.0
options_left_parameter 61 79 36 No 48 10.1 61 61 36 45 10.3 8.0
options_top_parameter 61 79 36 No 48 10.1 61 61 36 45 10.3 8.0

See also

© 2005–2023 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/Element/scrollTo