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 September 2020.
The scrollBy() method of the Element
interface scrolls an element by the given amount.
Syntax
js
scrollBy(xCoord, yCoord)
scrollBy(options)
Parameters
xCoord-
The horizontal pixel value that you want to scroll by.
yCoord-
The vertical pixel value that you want to scroll by.
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-
Specifies 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 element
element.scrollBy(300, 300);
Using options:
js
element.scrollBy({
top: 100,
left: 100,
behavior: "smooth",
});
Specifications
| Specification |
|---|
| CSSOM View Module # dom-element-scrollby |