Element: scroll() method
Baseline Widely available
This feature is well established and works across many devices and browser versions. It’s been available across browsers since January 2020.
Thescroll() method of theElementinterface scrolls the element to a particular set of coordinates inside a givenelement.
Syntax
scroll(xCoord, yCoord)scroll(options)Parameters
xCoordThe pixel along the horizontal axis of the element that you want displayed in theupper left.
yCoordThe pixel along the vertical axis of the element that you want displayed in theupper left.
optionsAn object containing the following properties:
topSpecifies the number of pixels along the Y axis to scroll the window or element.
leftSpecifies the number of pixels along the X axis to scroll the window or element.
behaviorDetermines 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
// Put the 1000th vertical pixel at the top of the elementelement.scroll(0, 1000);Usingoptions:
element.scroll({ top: 100, left: 100, behavior: "smooth",});Specifications
| Specification |
|---|
| CSSOM View Module # dom-element-scroll |