Element: scrollBy() 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.
ThescrollBy() method of theElementinterface scrolls an element by the given amount.
Syntax
js
scrollBy(xCoord, yCoord)scrollBy(options)Parameters
xCoordThe horizontal pixel value that you want toscroll by.
yCoordThe vertical pixel value that you want to scrollby.
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.
behaviorSpecifies 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
js
// scroll an elementelement.scrollBy(300, 300);Usingoptions:
js
element.scrollBy({ top: 100, left: 100, behavior: "smooth",});Specifications
| Specification |
|---|
| CSSOM View Module # dom-element-scrollby |