Window.scrollBy()

Baseline Widely available

This feature is well established and works across many devices and browser versions. It’s been available across browsers since July 2015.

Fait défiler le document dans la fenêtre du nombre de pixels passé en paramètre.

Syntaxe

js
window.scrollBy(X, Y);

Paramètres

  • X est le nombre en pixels pour le défilement horizontal.
  • Y est le nombre en pixels pour le défilement vertical.

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)

Des coordonnées positives feront défiler à droite et vers le bas de la page. Des coordonnées négatives feront défiler à gauche et vers le haut de la page.

Exemples

js
// fait défiler d'une page
window.scrollBy(0, window.innerHeight);

Notes

window.scrollBy fait défiler en fonction d'un nombre précis, alors que window.scroll fait défiler vers une position absolue dans le document. Voir aussi window.scrollByLines, window.scrollByPages

Spécifications

Specification
CSSOM View Module
# dom-window-scrollby