Window.scrollTo()

La méthode Window.scrollTo() permet de faire défiler la fenêtre pour atteindre les coordonnées données dans le document.

Syntaxe

js
scrollTo(x_coord, y_coord);
scrollTo(options);

Paramètres

x_coord

Le pixel sur l'axe horizontal du document dont on veut qu'il soit affiché dans le coin supérieur gauche.

y_coord

Le pixel sur l'axe vertical du document dont on veut qu'il soit affiché dans le coin supérieur gauche.

ou

options

Un dictionnaire avec les paramètres suivants :

top

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

left

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

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)

Valeur de retour

Aucune (undefined).

Exemples

Usage simple

js
window.scrollTo(0, 1000);

En utilisant options

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

Notes

Window.scroll() est la même que cette méthode. Pour le défilement relatif, voir les méthodes Window.scrollBy(), Window.scrollByLines(), et Window.scrollByPages().

Pour le défilement des éléments, voir Element.scrollTop et Element.scrollLeft.

Spécifications

Specification
CSSOM View Module
# dom-window-scrollto

Compatibilité des navigateurs

BCD tables only load in the browser