Element: scrollTo() method
Baseline Widely available
This feature is well established and works across many devices and browser versions. It’s been available across browsers since September 2020.
The scrollTo()
method of the Element
interface scrolls to a particular set of coordinates inside a given element.
Syntax
scrollTo(xCoord, yCoord)
scrollTo(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 smoothlyinstant
: scrolling should happen instantly in a single jumpauto
: scroll behavior is determined by the computed value ofscroll-behavior
Return value
None (undefined
).
Examples
element.scrollTo(0, 1000);
Using options
:
element.scrollTo({
top: 100,
left: 100,
behavior: "smooth",
});
Specifications
Specification |
---|
CSSOM View Module # dom-element-scrollto |
Browser compatibility
BCD tables only load in the browser