Window.scroll()

La méthode Window.scroll() permet de faire défiler la fenêtre jusqu'à un endroit donné du document.

Syntaxe

js

window.scroll(x, y);
window.scroll(options);

Paramètres

x

Le numéro de pixel sur l'axe horizontal du document qu'on souhaite avoir affiché dans le coin supérieur gauche.

y

Le numéro de pixel sur l'axe vertical du document qu'on souhaite avoir affiché dans le coin supérieur gauche.

Ou avec options :

options

Un dictionnaire qui contient les paramètres suivants :

top

Indique le nombre de pixels sur l'axe vertical le long desquels faire défiler la fenêtre ou l'élément.

left

Indique le nombre de pixels sur l'axe horizontal le long desquels faire défiler la fenêtre ou l'élément.

behavior

Indique si le défilement devrait être instantané ou doux. Cette option est une chaine de caractères qui doit être l'une de ces valeurs :

  • smooth : le défilement doit s'animer en douceur
  • instant : le défilement devrait se produire instantanément, en un seul saut
  • auto : le comportement de défilement est déterminé par la valeur calculée de (scroll-behavior)

Exemples

html

<!-- On place le 100e pixel, sur l'axe vertical, en haut de la fenêtre -->

<button onclick="scroll(0, 100);">
  Cliquez pour faire défiler jusqu'au 100e pixel
</button>

Avec options :

js

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

Notes

Window.scrollTo() est en pratique identique à cette méthode. Pour le défilement relatif, voir les méthodes Window.scrollBy(), Window.scrollByLines(), et Window.scrollByPages().

Pour faire défiler les éléments, voir Element.scrollTop et Element.scrollLeft.

Spécifications

Specification
CSSOM View Module
# dom-window-scroll

Compatibilité des navigateurs

BCD tables only load in the browser

Voir aussi