Summary

Scrolls to a particular set of coordinates in the document.

Syntax

window.scrollTo(x-coord[, y-coord])
window.scrollTo(options)

Parameters

  • x-coord is the pixel along the horizontal axis of the document that you want displayed in the upper left.
  • y-coord is the pixel along the vertical axis of the document that you want displayed in the upper left.
  • options is an object with three possible properties:
    • top, which is the same as the y-coord
    • left, which is the same as the x-coord
    • behavior, which is a string containing one of smooth, instant, or auto; default is auto

Examples

window.scrollTo( 0, 1000 );

// this changes the scrolling behavior to "smooth"
window.scrollTo({
    top: 1000,
    behavior: "smooth"
});

Notes

This function is effectively the same as window.scroll(). For relative scrolling, see window.scrollBy(), window.scrollByLines(), and window.scrollByPages().

For scrolling elements, see Element.scrollTop and Element.scrollLeft.

Specifications

Specification Status Comment
CSS Object Model (CSSOM) View Module
The definition of 'window.scroll()' in that specification.
Working Draft Initial definition.

Document Tags and Contributors

 Last updated by: chrisdavidmills,