Back to Content

Element: scroll() method

files/en-us/web/api/element/scroll/index.md

latest1.4 KB
Original Source

{{APIRef("CSSOM view API")}}

The scroll() method of the {{domxref("Element")}} interface scrolls the element to a particular set of coordinates inside a given element.

Syntax

js-nolint
scroll(xCoord, yCoord)
scroll(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 smoothly
          • instant: scrolling should happen instantly in a single jump
          • auto: scroll behavior is determined by the computed value of {{cssxref("scroll-behavior")}}

Return value

None ({{jsxref("undefined")}}).

Examples

js
// Put the 1000th vertical pixel at the top of the element
element.scroll(0, 1000);

Using options:

js
element.scroll({
  top: 100,
  left: 100,
  behavior: "smooth",
});

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}