WissensdatenbankPrüfungszentrum
DEDeutsch
Sprache wählen13

CKTIS / JavaScript

Elementhöhe und Scrollposition: offsetHeight, clientHeight und scrollTop

Unterscheide die Höhe der äußeren Elementbox, die Höhe des inneren Anzeigebereichs und die aktuelle vertikale Scrollposition. Erkenne das untere Ende, ohne auf exakte Zahlengleichheit angewiesen zu sein.

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

Syntax

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

Dies sind Eigenschaften des Browser-DOM, keine Bestandteile von ECMAScript. offsetHeight gehört zu HTMLElement; clientHeight und scrollTop gehören zu Element und werden von HTML-Elementen geerbt. Greife auf einer Elementinstanz darauf zu, etwa mit el.clientHeight. Alle Werte werden in CSS-Pixeln angegeben.

offsetHeight liefert die ganzzahlige Layouthöhe und ist schreibgeschützt. Die Höhe umfasst normalerweise Innenabstand (padding), Rahmen und eine gegebenenfalls dargestellte horizontale Scrollleiste, aber keinen Außenabstand. CSS-Transformationen bleiben unberücksichtigt. Für die Höhe des transformierten Begrenzungsrechtecks verwende el.getBoundingClientRect().height.

clientHeight liefert die ganzzahlige Innenhöhe und ist schreibgeschützt. Sie umfasst den Innenabstand, aber weder Rahmen noch Außenabstand oder horizontale Scrollleiste. Beide Höhen sind 0, wenn display: none am Element oder an einem Vorfahren dazu führt, dass das Element keine Layoutbox hat. Am Wurzelelement des Dokuments (body im Quirks-Modus) liefert clientHeight die Höhe des Viewports ohne horizontale Scrollleiste.

scrollTop liest oder setzt den vertikalen Scrollversatz relativ zum Scrollursprung. Oben ist der Wert normalerweise 0, er kann aber Nachkommastellen haben oder negativ sein, etwa bei flex-direction: column-reverse. Beim Federeffekt am Scrollrand kann Safari vorübergehend Werte außerhalb des normalen Bereichs melden. Mit el.scrollTop = y lässt sich Inhalt bei overflow: hidden scrollen, bei overflow: clip dagegen nicht.

scrollHeight ist die ganzzahlige Höhe des gesamten Inhalts einschließlich der nicht sichtbaren Überläufe und des Innenabstands. Bei einem gewöhnlichen, nach unten scrollenden Container ohne Überschwingen erkennst du das untere Ende mit Math.abs(el.scrollHeight - el.clientHeight - el.scrollTop) <= 1. Verwende statt === eine Toleranz von einem CSS-Pixel, weil scrollTop Nachkommastellen haben kann. Übernimm den Test nicht unverändert für Layouts mit umgekehrter Richtung.

Beispiele

<!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>

Ergebnis

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

Speichere das Beispiel als HTML-Datei, öffne sie im Browser und prüfe die Ausgabe in der Entwicklerkonsole. Der Rahmen erhöht `offsetHeight` um insgesamt 8 px, nicht aber `clientHeight`. Der Scrollversuch auf 1000 endet bei 200, der unteren Grenze.

Zugehörige Lektionen

  • JavaScript · Lektion 11 · Fortgeschritten · Version: 4

Quellen