Window.scroll()
The Window.scroll()
method scrolls the window to a particular place in the document.
Syntax
window.scroll(x-coord, y-coord) window.scroll(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.
- 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
-
Specifies whether the scrolling should animate smoothly (
smooth
), happen instantly in a single jump (instant
), or let the browser choose (auto
, default).
Examples
<!-- put the 100th vertical pixel at the top of the window --> <button onclick="scroll(0, 100);">click to scroll to the 100th pixel</button>
Using options
:
window.scroll({ top: 100, left: 100, behavior: 'smooth' });
Notes
Window.scrollTo()
is effectively the same as this method. For relative scrolling, see Window.scrollBy()
, Window.scrollByLines()
, and Window.scrollByPages()
.
For scrolling elements, see Element.scrollTop
and Element.scrollLeft
.
Specifications
Specification |
---|
CSSOM View Module (CSSOM View) # dom-window-scroll |
Browser compatibility
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Chrome | Edge | Firefox | Internet Explorer | Opera | Safari | WebView Android | Chrome Android | Firefox for Android | Opera Android | Safari on IOS | Samsung Internet | |
scroll |
1 |
12 |
1 |
4 |
3 |
1 |
1 |
18 |
4 |
10.1 |
1 |
1.0 |
options_behavior_parameter |
61 |
79 |
36 |
No |
48 |
14 |
61 |
61 |
36 |
45 |
14 |
8.0 |
options_left_parameter |
41 |
79 |
36 |
No |
28 |
10.1 |
41 |
41 |
36 |
28 |
10.3 |
4.0 |
options_top_parameter |
41 |
79 |
36 |
No |
28 |
10.1 |
41 |
41 |
36 |
28 |
10.3 |
4.0 |
See also
© 2005–2021 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/Window/scroll