Base de connaissancesCentre d’examen
FRFrançais
Choisir la langue13

CKTIS / JavaScript

Hauteur et position de défilement : offsetHeight, clientHeight et scrollTop

Distinguez la hauteur extérieure d’un élément, la hauteur de sa zone intérieure et sa position de défilement vertical. Apprenez à détecter le bas sans dépendre d’une égalité numérique exacte.

Version : ECMAScript 2024 and the current web platform; runtime support varies

Syntaxe

element.offsetHeight       // HTMLElement, read-only
 element.clientHeight       // Element, read-only
 element.scrollTop          // Element, read
 element.scrollTop = y      // Element, write a vertical offset in CSS pixels

Ces propriétés appartiennent au DOM du navigateur, pas à ECMAScript. offsetHeight appartient à HTMLElement ; clientHeight et scrollTop appartiennent à Element et sont héritées par les éléments HTML. Accédez-y sur une instance d’élément, par exemple avec el.clientHeight. Toutes ces mesures sont exprimées en pixels CSS.

offsetHeight est une hauteur de mise en page entière, en lecture seule. Elle comprend normalement le remplissage (padding), les bordures et la barre de défilement horizontale si elle est affichée, mais pas les marges. Elle ignore les transformations CSS ; pour mesurer la hauteur du rectangle englobant après transformation, utilisez el.getBoundingClientRect().height.

clientHeight est une hauteur intérieure entière, en lecture seule. Elle inclut le remplissage mais exclut les bordures, les marges et la barre de défilement horizontale. Les deux hauteurs valent 0 lorsque display: none sur l’élément ou un ancêtre le prive de boîte de mise en page. Sur l’élément racine du document (body en mode quirks), clientHeight donne la hauteur de la zone d’affichage hors barre de défilement horizontale.

scrollTop permet de lire ou de régler le décalage vertical par rapport à l’origine du défilement. Il vaut normalement 0 en haut, mais peut être fractionnaire ou négatif, par exemple avec flex-direction: column-reverse. Dans Safari, le rebond aux limites du défilement peut temporairement produire des valeurs hors de la plage normale. L’affectation el.scrollTop = y permet de faire défiler le contenu avec overflow: hidden, mais pas avec overflow: clip.

scrollHeight est la hauteur entière de tout le contenu, y compris ce qui déborde hors de la zone visible, avec le remplissage. Dans un conteneur qui défile normalement vers le bas, sans dépassement, détectez le bas avec Math.abs(el.scrollHeight - el.clientHeight - el.scrollTop) <= 1. Utilisez une tolérance d’un pixel CSS plutôt que ===, car scrollTop peut être fractionnaire. N’appliquez pas ce test tel quel aux mises en page inversées.

Exemples

<!doctype html>
<html lang="en">
<head>
  <meta charset="utf-8">
  <title>Element height and scroll position</title>
</head>
<body>
  <script>
    (() => {
      const box = document.createElement('div');
      box.style.cssText = 'position:fixed;top:0;left:0;width:160px;height:100px;' +
        'box-sizing:content-box;padding:0;border:4px solid;overflow:hidden;' +
        'scroll-behavior:auto;writing-mode:horizontal-tb;';
      const content = document.createElement('div');
      content.style.height = '300px';
      box.append(content);
      document.body.append(box);

      try {
        box.scrollTop = 40;
        console.log(`offsetHeight=${box.offsetHeight} clientHeight=${box.clientHeight} scrollHeight=${box.scrollHeight} scrollTop=${box.scrollTop}`);

        box.scrollTop = 1000;
        const atBottom = Math.abs(box.scrollHeight - box.clientHeight - box.scrollTop) <= 1;
        console.log(`scrollTop=${box.scrollTop} atBottom=${atBottom}`);
      } finally {
        box.remove();
      }
    })();
  </script>
</body>
</html>

Résultat

offsetHeight=108 clientHeight=100 scrollHeight=300 scrollTop=40
scrollTop=200 atBottom=true

Enregistrez l’exemple dans un fichier HTML, ouvrez-le dans un navigateur et consultez le résultat dans la console de développement. Les bordures ajoutent 8 px à `offsetHeight`, mais pas à `clientHeight`. La tentative de défilement jusqu’à 1000 s’arrête à 200, la limite du bas.

Leçons associées

  • JavaScript · Leçon 11 · Avancé · Version : 4

Sources