IntersectionObserver API 使用教程
xsbm1994
8年前
<p>网页开发时,常常需要了解某个元素是否进入了"视口"(viewport),即用户能不能看到它。</p> <p style="text-align:center"><img src="https://simg.open-open.com/show/95d9c70d3fd4a0ec00c44b1fb028c2d8.gif"></p> <p>上图的绿色方块不断滚动,顶部会提示它的可见性。</p> <p>传统的实现方法是,监听到 scroll 事件后,调用目标元素(绿色方块)的 getBoundingClientRect() 方法,得到它对应于视口左上角的坐标,再判断是否在视口之内。这种方法的缺点是,由于 scroll 事件密集发生,计算量很大,容易造成性能问题。</p> <p>目前有一个新的 IntersectionObserver API ,可以自动"观察"元素是否可见,Chrome 51+ 已经支持。由于可见(visible)的本质是,目标元素与视口产生一个交叉区,所以这个 API 叫做"交叉观察器"。</p> <h2><strong>一、API</strong></h2> <p>它的用法非常简单。</p> <pre> <code class="language-javascript">var io = new IntersectionObserver(callback, option);</code></pre> <p>上面代码中, IntersectionObserver 是浏览器原生提供的构造函数,接受两个参数: callback 是可见性变化时的回调函数, option 是配置对象(该参数可选)。</p> <p>构造函数的返回值是一个观察器实例。实例的 observe 方法可以指定观察哪个 DOM 节点。</p> <pre> <code class="language-javascript">// 开始观察 io.observe(document.getElementById('example')); // 停止观察 io.unobserve(element); // 关闭观察器 io.disconnect();</code></pre> <p>上面代码中, observe 的参数是一个 DOM 节点对象。如果要观察多个节点,就要多次调用这个方法。</p> <pre> <code class="language-javascript">io.observe(elementA); io.observe(elementB);</code></pre> <h2><strong>二、callback 参数</strong></h2> <p>目标元素的可见性变化时,就会调用观察器的回调函数 callback 。</p> <p>callback 一般会触发两次。一次是目标元素刚刚进入视口(开始可见),另一次是完全离开视口(开始不可见)。</p> <pre> <code class="language-javascript">var io = new IntersectionObserver( entries => { console.log(entries); } );</code></pre> <p>上面代码中,回调函数采用的是箭头函数的写法。 callback 函数的参数( entries )是一个数组,每个成员都是一个 IntersectionObserverEntry 对象。举例来说,如果同时有两个被观察的对象的可见性发生变化, entries 数组就会有两个成员。</p> <h2><strong>三、IntersectionObserverEntry 对象</strong></h2> <p>IntersectionObserverEntry 对象提供目标元素的信息,一共有六个属性。</p> <pre> <code class="language-javascript">{ time: 3893.92, rootBounds: ClientRect { bottom: 920, height: 1024, left: 0, right: 1024, top: 0, width: 920 }, boundingClientRect: ClientRect { // ... }, intersectionRect: ClientRect { // ... }, intersectionRatio: 0.54, target: element }</code></pre> <p>每个属性的含义如下。</p> <ul> <li>time :可见性发生变化的时间,是一个高精度时间戳,单位为毫秒</li> <li>target :被观察的目标元素,是一个 DOM 节点对象</li> <li>rootBounds :根元素的矩形区域的信息, getBoundingClientRect() 方法的返回值,如果没有根元素(即直接相对于视口滚动),则返回 null</li> <li>boundingClientRect :目标元素的矩形区域的信息</li> <li>intersectionRect :目标元素与视口(或根元素)的交叉区域的信息</li> <li>intersectionRatio :目标元素的可见比例,即 intersectionRect 占 boundingClientRect 的比例,完全可见时为 1 ,完全不可见时小于等于 0</li> </ul> <p style="text-align:center"><img src="https://simg.open-open.com/show/876488ca20946ac01175033f9d11055d.png"></p> <p>上图中,灰色的水平方框代表视口,深红色的区域代表四个被观察的目标元素。它们各自的 intersectionRatio 图中都已经注明。</p> <h2><strong>四、实例:惰性加载(lazy load)</strong></h2> <p>有时,我们希望某些静态资源(比如图片),只有用户向下滚动,它们进入视口时才加载,这样可以节省带宽,提高网页性能。这就叫做"惰性加载"。</p> <p>有了 IntersectionObserver API,实现起来就很容易了。</p> <pre> <code class="language-javascript">function query(selector) { return Array.from(document.querySelectorAll(selector)); } var observer = new IntersectionObserver( function(changes) { changes.forEach(function(change) { var container = change.target; var content = container.querySelector('template').content; container.appendChild(content); observer.unobserve(container); }); } ); query('.lazy-loaded').forEach(function (item) { observer.observe(item); });</code></pre> <p>上面代码中,只有目标区域可见时,才会将模板内容插入真实 DOM,从而引发静态资源的加载。</p> <h2><strong>五、实例:无限滚动</strong></h2> <p>无限滚动(infinite scroll)的实现也很简单。</p> <pre> <code class="language-javascript">var intersectionObserver = new IntersectionObserver( function (entries) { // 如果不可见,就返回 if (entries[0].intersectionRatio <= 0) return; loadItems(10); console.log('Loaded new items'); }); // 开始观察 intersectionObserver.observe( document.querySelector('.scrollerFooter') );</code></pre> <p>无限滚动时,最好在页面底部有一个页尾栏(又称sentinels)。一旦页尾栏可见,就表示用户到达了页面底部,从而加载新的条目放在页尾栏前面。这样做的好处是,不需要再一次调用 observe() 方法,现有的 IntersectionObserver 可以保持使用。</p> <h2><strong>六、Option 对象</strong></h2> <p>IntersectionObserver 构造函数的第二个参数是一个配置对象。它可以设置以下属性。</p> <h3><strong>6.1 threshold 属性</strong></h3> <p>threshold 属性决定了什么时候触发回调函数。它是一个数组,每个成员都是一个门槛值,默认为 [0] ,即交叉比例( intersectionRatio )达到 0 时触发回调函数。</p> <pre> <code class="language-javascript">new IntersectionObserver( entries => {/* ... */}, { threshold: [0, 0.25, 0.5, 0.75, 1] } );</code></pre> <p>用户可以自定义这个数组。比如, [0, 0.25, 0.5, 0.75, 1] 就表示当目标元素 0%、25%、50%、75%、100% 可见时,会触发回调函数。</p> <p style="text-align:center"><img src="https://simg.open-open.com/show/5a139e92f2f51fe8ea932f15ec7d2fb6.gif"></p> <h3><strong>6.2 root 属性,rootMargin 属性</strong></h3> <p>很多时候,目标元素不仅会随着窗口滚动,还会在容器里面滚动(比如在 iframe 窗口里滚动)。容器内滚动也会影响目标元素的可见性,参见本文开始时的那张示意图。</p> <p>IntersectionObserver API 支持容器内滚动。 root 属性指定目标元素所在的容器节点(即根元素)。注意,容器元素必须是目标元素的祖先节点。</p> <pre> <code class="language-javascript">var opts = { root: document.querySelector('.container'), rootMargin: "500px 0px" }; var observer = new IntersectionObserver( callback, opts );</code></pre> <p>上面代码中,除了 root 属性,还有 rootMargin 属性。后者定义根元素的 margin ,用来扩展或缩小 rootBounds 这个矩形的大小,从而影响 intersectionRect 交叉区域的大小。它使用CSS的定义方法,比如 10px 20px 30px 40px ,表示 top、right、bottom 和 left 四个方向的值。</p> <p>这样设置以后,不管是窗口滚动或者容器内滚动,只要目标元素可见性变化,都会触发观察器。</p> <h2><strong>七、注意点</strong></h2> <p>IntersectionObserver API 是异步的,不随着目标元素的滚动同步触发。</p> <p>规格写明, IntersectionObserver 的实现,应该采用 requestIdleCallback() ,即只有线程空闲下来,才会执行观察器。这意味着,这个观察器的优先级非常低,只在其他任务执行完,浏览器有了空闲才会执行。</p> <h2><strong>八、参考链接</strong></h2> <ul> <li><a href="/misc/goto?guid=4959723798153876812" rel="nofollow,noindex">IntersectionObserver's Coming into View</a></li> <li><a href="/misc/goto?guid=4959723798248851552" rel="nofollow,noindex">Intersection Observers Explained</a></li> </ul> <p> </p> <p>来自:http://www.ruanyifeng.com/blog/2016/11/intersectionobserver_api.html</p> <p> </p>