使用 jQuery 获取 div 的可见高度

Question

我需要检索可滚动区域内 div 的可见高度。我认为自己在使用 jQuery 方面相当不错，但这完全让我失望。

假设我有一个黑色包装内的红色 div：

在上图中，jQuery 函数将返回 248，即 div 的可见部分。

一旦用户滚动到 div 的顶部，如上图所示，它将报告 296。

现在，一旦用户滚动过去 div，它会再次报告 248。

显然我的数字不会像在这个演示中那样一致和清晰，或者我只是硬编码这些数字。

我有一点理论：

• 获取窗口高度
• 获取div的高度
• 从窗口顶部获取 div 的初始偏移量
• 在用户滚动时获取偏移量。
  • 如果偏移量为正，则表示 div 的顶部仍然可见。
  • 如果为负数，则 div 的顶部已被窗口遮住。此时，div 可能占据了窗口的整个高度，也可能显示 div 的底部
  • 如果显示了 div 的底部，请找出它与窗口底部之间的间隙。

看起来很简单，但我就是想不通。明天早上我会再吃一次；我只是想你们中的一些天才可能会提供帮助。

谢谢！

更新：我自己解决了这个问题，但看起来下面的答案之一更优雅，所以我将改用它。对于好奇的人，这就是我想出的：

$(document).ready(function() {
    var windowHeight = $(window).height();
    var overviewHeight = $("#overview").height();
    var overviewStaticTop = $("#overview").offset().top;
    var overviewScrollTop = overviewStaticTop - $(window).scrollTop();
    var overviewStaticBottom = overviewStaticTop + $("#overview").height();
    var overviewScrollBottom = windowHeight - (overviewStaticBottom - $(window).scrollTop());
    var visibleArea;
    if ((overviewHeight + overviewScrollTop) < windowHeight) {
        // alert("bottom is showing!");
        visibleArea = windowHeight - overviewScrollBottom;
        // alert(visibleArea);
    } else {
        if (overviewScrollTop < 0) {
            // alert("is full height");
            visibleArea = windowHeight;
            // alert(visibleArea);
        } else {
            // alert("top is showing");
            visibleArea = windowHeight - overviewScrollTop;
            // alert(visibleArea);
        }
    }
});

Answer 1

这是一个快速而肮脏的概念。它基本上将元素的offset().top 与窗口顶部进行比较，将offset().top + height() 与窗口底部进行比较：

function getVisible() {
  var $el = $('#foo'),
    scrollTop = $(this).scrollTop(),
    scrollBot = scrollTop + $(this).height(),
    elTop = $el.offset().top,
    elBottom = elTop + $el.outerHeight(),
    visibleTop = elTop < scrollTop ? scrollTop : elTop,
    visibleBottom = elBottom > scrollBot ? scrollBot : elBottom;
  $('#notification').text(`Visible height of div: ${visibleBottom - visibleTop}px`);
}

$(window).on('scroll resize', getVisible).trigger('scroll');

html,
body {
  margin: 100px 0;
}

#foo {
  height: 1000px;
  background-color: #C00;
  width: 200px;
  margin: 0 auto;
}

#notification {
  position: fixed;
  top: 0;
  left: 0;
}

<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.6.0/jquery.min.js"></script>
<div id="foo"></div>
<div id="notification"></div>

如有必要，逻辑可以更简洁，我刚刚为这个示例声明了单独的变量，以使计算尽可能清晰。

Answer 2

计算一个元素（高度）在视口中的像素数

Fiddle demo

这个小函数将返回一个元素在（垂直）视口中可见的px的数量：

function inViewport($el) {
    var elH = $el.outerHeight(),
        H   = $(window).height(),
        r   = $el[0].getBoundingClientRect(), t=r.top, b=r.bottom;
    return Math.max(0, t>0? Math.min(elH, H-t) : Math.min(b, H));
}

像这样使用：

$(window).on("scroll resize", function(){
  console.log( inViewport($('#elementID')) ); // n px in viewport
});

就是这样。

---

jQuery .inViewport() 插件

jsFiddle demo

从上面你可以提取逻辑并创建一个像这样的插件：

/**
 * inViewport jQuery plugin by Roko C.B.
 * http://stackoverflow.com/a/26831113/383904
 * Returns a callback function with an argument holding
 * the current amount of px an element is visible in viewport
 * (The min returned value is 0 (element outside of viewport)
 */
;(function($, win) {
  $.fn.inViewport = function(cb) {
     return this.each(function(i,el) {
       function visPx(){
         var elH = $(el).outerHeight(),
             H = $(win).height(),
             r = el.getBoundingClientRect(), t=r.top, b=r.bottom;
         return cb.call(el, Math.max(0, t>0? Math.min(elH, H-t) : Math.min(b, H)));  
       }
       visPx();
       $(win).on("resize scroll", visPx);
     });
  };
}(jQuery, window));

像这样使用：

$("selector").inViewport(function(px) {
  console.log( px ); // `px` represents the amount of visible height
  if(px > 0) {
    // do this if element enters the viewport // px > 0
  }else{
    // do that if element exits  the viewport // px = 0
  }
}); // Here you can chain other jQuery methods to your selector

您的选择器将动态侦听窗口 scroll 和 resize，但也会通过第一个回调函数参数 px 返回 DOM 就绪时的初始值。

Answer 3

这是上述 Rory 方法的一个版本，除了编写为用作 jQuery 插件。它在该格式中可能具有更普遍的适用性。很好的答案，Rory - 谢谢！

$.fn.visibleHeight = function() {
    var elBottom, elTop, scrollBot, scrollTop, visibleBottom, visibleTop;
    scrollTop = $(window).scrollTop();
    scrollBot = scrollTop + $(window).height();
    elTop = this.offset().top;
    elBottom = elTop + this.outerHeight();
    visibleTop = elTop < scrollTop ? scrollTop : elTop;
    visibleBottom = elBottom > scrollBot ? scrollBot : elBottom;
    return visibleBottom - visibleTop
}

可以通过以下方式调用：

$("#myDiv").visibleHeight();

jsFiddle