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(x-coord, y-coord)
scroll(options)
Parameters
x-coord
-
The pixel along the horizontal axis of the element that you want displayed in the upper left.
y-coord
-
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 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 element
element.scroll(0, 1000);
Using options
:
element.scroll({
top: 100,
left: 100,
behavior: "smooth",
});
Specifications
Specification |
---|
CSSOM View Module # dom-element-scroll |
Browser compatibility
BCD tables only load in the browser