ResizeObserver保持俩个div大小一致或者同时监听多个元素

2023-12-11 17:44

本文主要是介绍ResizeObserver保持俩个div大小一致或者同时监听多个元素,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

前言

大家在遇到需要监测DOM元素尺寸大小的需求时,可能第一时间想到的都是使用window.addEventListener来监听resize 事件,

但是reize事件会在一秒内触发将近60次,所以很容易在改变窗口大小时导致性能问题。因为它会监听我们页面每个元素的大小变化,而不是具体到某个元素的变化。如果我们只想监听某个元素的变化的话,这种操作就很浪费性能了。 并且只有在window对象才有resize事件(其他hack方法,比如resize事件,scroll事件,requestAnimationFrame等等)

而ResizeObserver API就可以帮助我们:监听一个DOM节点的变化,这种变化包括但不仅限于:

  1. 某个节点的出现和隐藏
  2. 某个节点的大小变化

1. ResizeObserver

ResizeObserver作为一个标准的web``api,它的作用是监听dom元素的大小变化,它的api非常简单,只有一个observe方法,它接受一个dom元素作为参数,然后就可以监听这个dom元素的大小变化了,当然,我们也可以使用unobserve方法来停止监听这个dom元素的大小变化。

我们先来看一下ResizeObserver的函数签名:

interface ResizeObserver {constructor(callback: ResizeObserverCallback): void;observe(target: Element): void;unobserve(target: Element): void;disconnect(): void;
}interface ResizeObserverCallback {(entries: ResizeObserverEntry[], observer: ResizeObserver): void;
}

ResizeObserver是一个web标准的api,所以我们可以放心的使用它,它的作用是监听dom元素的大小变化,它的使用方法如下:

const resizeObserver = new ResizeObserver((entries) => {for (const entry of entries) {const { width, height } = entry.contentRect;console.log(`Element: ${entry.target}`);console.log(`Element size: ${width}px x ${height}px`);console.log(`Element padding: ${entry.paddingBoxSize}`);}
});resizeObserver.observe(document.querySelector('.resize'));

上面的代码中,我们创建了一个ResizeObserver实例,然后调用observe方法来监听dom元素的大小变化,当dom元素的大小发生变化的时候,ResizeObserver实例会触发回调函数,回调函数的参数是一个entries数组,数组中的每一项都是一个ResizeObserverEntry对象,它包含了dom元素的大小信息,我们可以通过contentRect属性来获取dom元素的大小信息,它是一个DOMRectReadOnly对象,它包含了dom元素的大小信息,我们可以通过widthheight属性来获取dom元素的宽度和高度,我们也可以通过paddingBoxSize属性来获取dom元素的padding的大小。

2. ResizeObserverEntry

上面的关键点在于回调函数中的entries参数,它是一个ResizeObserverEntry对象的数组,我们可以通过它来获取dom元素的大小信息。

ResizeObserverEntry对象包含了dom元素的大小信息,它的属性如下:

  • borderBoxSizedom元素的border的大小。
  • contentBoxSizedom元素的content的大小。
  • contentRectdom元素的大小信息,它是一个DOMRectReadOnly对象,它包含了dom元素的大小信息,我们可以通过widthheight属性来获取dom元素的宽度和高度,我们也可以通过paddingBoxSize属性来获取dom元素的padding的大小。
  • devicePixelContentBoxSizedom元素的devicePixelContent的大小。
  • targetdom元素。
  • timedom元素大小变化的时间。
  • transformBoxdom元素的transform的大小。
  • xdom元素的x轴的大小。
  • ydom元素的y轴的大小。
  • constructorResizeObserverEntry对象的构造函数。
  • isBoxSizeSynceddom元素的大小是否同步。

3.用法

ResizeObserver是个构造函数。在使用new关键字调用构造函数,返回实例对象时,需要传入一个回调函数,这个回调用于监听实例对象某个DOM节点的变化

// HTML
<div class="wrapper" ref="wrapper"></div>// css
.wrapper {height: 500px;background-color: blueviolet;
}// jsmounted() {const resizeObserver = new ResizeObserver((entries, observer) => {entries.forEach(entry => {const { target, contentRect } = entry;// 处理元素尺寸变化// contentRect包含了元素的新尺寸和位置信息const target = entry.target; const contentRect = entry.contentRect;console.log(`目标元素: ${target}`); console.log(`宽度: ${contentRect.width}px`);console.log(`高度: ${contentRect.height}px`);})})
}

效果展示:

另外我们可以给回调函数添加一个参数,用来获取到该元素的一些信息 然后,实例对象myObserver方法除了有observe方法之外,还有disconnect方法和unobserve方法。

4.Resize方法

1. ResizeObserver.observe()

ResizeObserver.observe() 方法用于开始观察一个 DOM 元素的大小变化。当元素的大小发生变化时,Resize Observer 会调用注册的回调函数。

const resizeObserver = new ResizeObserver(entries => {for (const entry of entries) {// 处理大小变化}
});const elementToObserve = document.getElementById('myElement');
resizeObserver.observe(elementToObserve);

并且我们可以观察多个元素,只需分别使用observe方法指定不同的目标元素。

const target1 = document.querySelector('#element1');
const target2 = document.querySelector('#element2');
observer.observe(target1);
observer.observe(target2);
2. ResizeObserver.disconnect()

ResizeObserver.disconnect() 方法用于停止观察一个 DOM 元素的大小变化。一旦调用 disconnect(),观察将立即停止,不再触发回调函数。

resizeObserver.disconnect(); // 停止观察所有被观察的元素
3. ResizeObserver.unobserve()

ResizeObserver.unobserve() 方法用于停止观察一个或多个 DOM 元素的大小变化。我们可以多次调用 unobserve() 来停止观察不同的元素。

const elementToUnobserve = document.getElementById('elementToStopObserving');
resizeObserver.unobserve(elementToUnobserve); // 停止观察特定元素

5.性能优化

全局唯一实例的性能优化

其实,ResizeObserver的诞生,相较于MutationObserver以及传统的resize事件,本身就是高效的尺寸变化监测。它的精准性避免了很多不必要的性能开销。

但在最近的一个项目中,由于业务需求,需要通过ResizeObserver监听动态列表项高度,将它加在了一个长列表的每一项。由于每一项都是一个单独的组件,每个组件都拥有自己的 ResizeObserver 实例,这意味着浏览器会为每个实例分配内存和处理事件。当页面上有大量组件时,会对性能产生相当程度的影响。

细心的读者应该发现了,每个ResizeObserver实例是可以同时监听多个目标元素的,那么借鉴单例模式的思想,尝试封装一个全局的ResizeObserver,限制整个项目只有一个实例。在需要调用的地方直接GlobalResizeObserver.observe()!话不多说,上代码:

export const GlobalResizeObserver = (function() {  const ATTR_NAME = 'global-resizeobserver-key';  const attrValueToCallback = {};  const o = new ResizeObserver((entries) => {  for (const entry of entries) {  const resizedElement = entry.target;  const attrValue = resizedElement.getAttribute(ATTR_NAME);  if (attrValue) {  const callback = attrValueToCallback[attrValue];  if (typeof callback === 'function') {  callback(entry);  }  }  }  });  return Object.freeze({  /**  * @param { Element } element  * @param { (ResizeObserverEntry) => {} } callback  */  observe(element, callback) {  if (!(element instanceof Element)) {  console.error('GlobalResizeObserver, cannot observe non-Element.');  return;  }  let attrValue = element.getAttribute(ATTR_NAME);  if (!attrValue) {  attrValue = String(Math.random());  element.setAttribute(ATTR_NAME, attrValue);  }  attrValueToCallback[attrValue] = callback;  o.observe(element);  },  /**  * @param { Element } element  */  unobserve(element) {  if (!(element instanceof Element)) {  console.error('GlobalResizeObserver cannot unobserve non-Element.');  return;  }  const attrValue = element.getAttribute(ATTR_NAME);  if (!attrValue) {  console.error('GlobalResizeObserver cannot unobserve element w/o ATTR_NAME.'); return;  }  delete attrValueToCallback[attrValue];  o.unobserve(element);  }});  
})();

主要思路是通过JS的闭包特性,构建对象保存每个被监听元素对应的callback。

通过构建全局唯一的ResizeObserver实例,页面的fps, Response Time, CPU Usage, Memory Consumption, Event Handling等性能指标都有了提升!

当然,如果监听的目标元素足够多,相应的给callback函数加上防抖节流也是很有必要的,毕竟前端页面性能直接关乎用户体验的好坏。

在React中的使用

不管是原生的生成实例用法,还是封装全局唯一实例,在React中的使用应该不存在什么最佳实践,仁者见仁,智者见智。这里仅介绍一种回调ref的做法,供大家参考。

import React, { useCallback } from 'react';
import { GlobalResizeObserver } from 'global-resize-observer';export const component = () => {const callbackRef = useCallback((node) => {  if (!node) {  GlobalResizeObserver.unobserve(node);  return;  }          GlobalResizeObserver.observe(node, (entry) => {  // 响应逻辑...  });  }, []);return <div ref={callbackRef}></div>
}

callbackRef会将当前ref的值作为函数入参传入,并通过useCallback封装,并且依赖数组为[],所以callbackRef会在组件初始化和卸载阶段被调用,执行绑定和解绑逻辑,不失为一种优雅调用方法~

6.示例-俩个div大小保持一致

<template><div class="list-transfer-wrap"><SelectList id="selectListRef" ref="selectListRef"/><SelectedList id="selectedListRef" ref="selectedListRef" /></div>
</template><script>
import _ from 'lodash';
import SelectList from '';
import SelectedList from '';export default {name: 'CascadeTransfer',components: { SelectList, SelectedList },provide() {return {cascadeTransfer: this};},props: {products: {type: Array,default: () => []},},data() {return {resizeObserver: undefined,lastResizeWidth: 482 // 初值};},mounted() {// new ResizeObserverthis.observeResizeHandler(// 同时绑定俩个div,进行监听[document.getElementById('selectListRef'), document.getElementById('selectedListRef')],_.throttle(this.upWidth, 400, { trailing: true }) // 节流,400ms内只执行最后一次变动);},beforeUnmount() {this.observeResizeHandler.disconnect(); // 销毁},methods: {observeResizeHandler(elements, callback) {if (!this.resizeObserver) {this.resizeObserver = new ResizeObserver(entries => {for (const entry of entries) {callback(entry);}});}elements.forEach(element => {this.resizeObserver.observe(element);});},upWidth(entry) {const {contentRect} = entry;// 获取值时有border差异,导致有2px容错if (Math.abs(this.lastResizeWidth - contentRect.width) < 3) return;this.lastResizeWidth = contentRect.width;if (entry.target.getAttribute('class').includes('l-wrap')) {this.$refs.selectedListRef.width = contentRect.width;} else {this.$refs.selectListRef.width = contentRect.width;}}}
};
</script>

浏览器兼容性

作为一个新兴的apiResizeObserver的兼容性还不是很好,目前只有ChromeFirefox支持它,SafariEdge还不支持,所以我们在使用的时候需要注意一下。

ResizeObserver的兼容性如下:

  • Chrome:v64及以上。
  • Firefox:v63及以上。
  • Safari:v13及以上。
  • Edge:v79及以上。
  • Opera:v51及以上。

可以去caniuse查看更多的兼容性信息。

总结

ResizeObserver解决了我们没用监听dom大小变化的难题,作为新一代的标准api,它的兼容性虽然还不是很好,但是还是可以添加polyfill来解决兼容性的问题,所以我们可以放心的使用它。

最后使用之后记得清除ResizeObserver对象,否则会造成内存泄漏。

参考:developer.mozilla.org/zh-CN/docs/…

这篇关于ResizeObserver保持俩个div大小一致或者同时监听多个元素的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/481530

相关文章

C# 比较两个list 之间元素差异的常用方法

《C#比较两个list之间元素差异的常用方法》:本文主要介绍C#比较两个list之间元素差异,本文通过实例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友参考下吧... 目录1. 使用Except方法2. 使用Except的逆操作3. 使用LINQ的Join,GroupJoin

python3如何找到字典的下标index、获取list中指定元素的位置索引

《python3如何找到字典的下标index、获取list中指定元素的位置索引》:本文主要介绍python3如何找到字典的下标index、获取list中指定元素的位置索引问题,具有很好的参考价值,... 目录enumerate()找到字典的下标 index获取list中指定元素的位置索引总结enumerat

CSS实现元素撑满剩余空间的五种方法

《CSS实现元素撑满剩余空间的五种方法》在日常开发中,我们经常需要让某个元素占据容器的剩余空间,本文将介绍5种不同的方法来实现这个需求,并分析各种方法的优缺点,感兴趣的朋友一起看看吧... css实现元素撑满剩余空间的5种方法 在日常开发中,我们经常需要让某个元素占据容器的剩余空间。这是一个常见的布局需求

使用jenv工具管理多个JDK版本的方法步骤

《使用jenv工具管理多个JDK版本的方法步骤》jenv是一个开源的Java环境管理工具,旨在帮助开发者在同一台机器上轻松管理和切换多个Java版本,:本文主要介绍使用jenv工具管理多个JD... 目录一、jenv到底是干啥的?二、jenv的核心功能(一)管理多个Java版本(二)支持插件扩展(三)环境隔

Java中JSON格式反序列化为Map且保证存取顺序一致的问题

《Java中JSON格式反序列化为Map且保证存取顺序一致的问题》:本文主要介绍Java中JSON格式反序列化为Map且保证存取顺序一致的问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未... 目录背景问题解决方法总结背景做项目涉及两个微服务之间传数据时,需要提供方将Map类型的数据序列化为co

Apache 高级配置实战之从连接保持到日志分析的完整指南

《Apache高级配置实战之从连接保持到日志分析的完整指南》本文带你从连接保持优化开始,一路走到访问控制和日志管理,最后用AWStats来分析网站数据,对Apache配置日志分析相关知识感兴趣的朋友... 目录Apache 高级配置实战:从连接保持到日志分析的完整指南前言 一、Apache 连接保持 - 性

Python函数返回多个值的多种方法小结

《Python函数返回多个值的多种方法小结》在Python中,函数通常用于封装一段代码,使其可以重复调用,有时,我们希望一个函数能够返回多个值,Python提供了几种不同的方法来实现这一点,需要的朋友... 目录一、使用元组(Tuple):二、使用列表(list)三、使用字典(Dictionary)四、 使

Kotlin Compose Button 实现长按监听并实现动画效果(完整代码)

《KotlinComposeButton实现长按监听并实现动画效果(完整代码)》想要实现长按按钮开始录音,松开发送的功能,因此为了实现这些功能就需要自己写一个Button来解决问题,下面小编给大... 目录Button 实现原理1. Surface 的作用(关键)2. InteractionSource3.

Java中Switch Case多个条件处理方法举例

《Java中SwitchCase多个条件处理方法举例》Java中switch语句用于根据变量值执行不同代码块,适用于多个条件的处理,:本文主要介绍Java中SwitchCase多个条件处理的相... 目录前言基本语法处理多个条件示例1:合并相同代码的多个case示例2:通过字符串合并多个case进阶用法使用

基于Java实现回调监听工具类

《基于Java实现回调监听工具类》这篇文章主要为大家详细介绍了如何基于Java实现一个回调监听工具类,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下... 目录监听接口类 Listenable实际用法打印结果首先,会用到 函数式接口 Consumer, 通过这个可以解耦回调方法,下面先写一个