resize_看看Resize Observer JavaScript API

落日映苍穹つ 2022-11-27 04:28 204阅读 0赞

resize

[Resize Observer][] is a new JavaScript API that’s very similar to other observer APIs like the [Intersection Observer API][]. It allows for elements to be notified when their size changes.

[Resize Observer][]是一个新JavaScript API，与诸如[Intersection Observer API之][Intersection Observer API]类的其他观察者API非常相似。 它允许在元素大小更改时通知元素。

The most frequent reason for an element’s size to change is when the viewport is resized or the device’s direction changes between portrait and landscape. Up until this point, we’ve had to rely on the global `window.resize` event to listen for resize events and check if certain elements have changed size. This can easily lead to performance problems due to the large amount of triggered event. In other words, using `window.resize` is often wasteful because it informs us of every viewport size change, not just when an element’s size actually changes.

更改元素大小的最常见原因是调整视口大小或设备的方向在纵向和横向之间变化。 到目前为止，我们必须依靠全局`window.resize`事件来监听resize事件并检查某些元素是否已更改大小。 由于大量触发事件，这很容易导致性能问题。 换句话说，使用`window.resize`通常很浪费，因为它会通知我们每个视口大小的变化，而不仅仅是告知元素尺寸实际发生的变化。

There’s also another use case for the **Resize Observer API** that the window’s resize event can’t help us with: when elements are added or removed from the DOM dynamically, influencing the size of the parent element. This is more and more frequent with modern single-page apps.

**Resize Observer API的**另一个用例是窗口的resize事件无法帮助我们：动态添加或从DOM中删除元素时，会影响父元素的大小。 对于现代的单页应用程序，这种情况越来越常见。

## 基本用法 **(**Basic Usage**)** ##

Using Resize Observer is as simple as instantiating a new ResizeObserver object and passing-in a callback function that receives the entries that are observed:

使用Resize Observer就像实例化一个新的ResizeObserver对象并传入一个回调函数一样简单，该回调函数接收观察到的条目：

const myObserver = new ResizeObserver(entries => {
      // iterate over the entries, do something.
    });

Then, we can call observe on our instance and pass-in an element to observe:

然后，我们可以在实例上调用observe ，并传入一个元素进行观察：

const someEl = document.querySelector('.some-element');
    const someOtherEl = document.querySelector('.some-other-element');
    
    myObserver.observe(someEl);
    myObserver.observe(someOtherEl);

With each entry, we get an object with a contentRect and a target property. The **target** is the DOM element itself, and **contentRect** is an object with the following properties: width, height, x, y, top, right, bottom and left.

对于每个条目，我们都会获得一个具有contentRect和target属性的对象 。 **目标**是DOM元素本身， **contentRect**是具有以下属性的对象： width ， height ， x ， y ， top ， right ， bottom和left 。

Unlike with an element’s getBoundingClientRect, contentRect’s values for width and height don’t include padding values. `contentRect.top` is the element’s top padding and `contentRect.left` is the element’s left padding.

与元素的getBoundingClientRect不同，contentRect的width和height的值不包含填充值。 `contentRect.top`是元素的顶部填充， `contentRect.left`是元素的左侧填充。

--------------------

If, for example, we want log an observed element’s width and height when the element’s size changes, we could do something like this:

例如，如果我们想在元素大小改变时记录观察到的元素的宽度和高度，则可以执行以下操作：

const myObserver = new ResizeObserver(entries => {
      entries.forEach(entry => {
        console.log('width', entry.contentRect.width);
        console.log('height', entry.contentRect.height);
      });
    });
    
    const someEl = document.querySelector('.some-element');
    myObserver.observe(someEl);

## 简单演示 **(**Simple Demo**)** ##

Below is a simple demonstration to see the Resize Observer API in action. Try it out by resizing your browser window and notice how the gradient angle and text content only change when the element’s size is actually affected:

以下是一个简单的演示，以了解实际中的Resize Observer API。 通过调整浏览器窗口的大小来尝试一下，请注意仅当元素的大小实际受到影响时，渐变角度和文本内容才会发生变化：

--------------------

Let’s break down this simple demo. First, we start with some simple markup:

让我们分解一下这个简单的演示。 首先，我们从一些简单的标记开始：

And a touch of styles:

还有一点风格：

.box {
      text-align: center;
      height: 20vh;
      border-radius: 8px;
      box-shadow: 0 0 4px var(--subtle);
    
      display: flex;
      justify-content: center;
      align-items: center;
    }
    
    .box h3 {
      color: #fff;
      margin: 0;
      font-size: 5vmin;
      text-shadow: 0 0 10px rgba(0,0,0,0.4);
    }
    
    .box.small {
      max-width: 550px;
      margin: 1rem auto;
    }

Notice how we don’t need to apply our gradient background to the .box element. The resize observer will be called once when the page first loads and our gradient will be applied then.

注意，我们不需要将渐变背景应用于.box元素。 第一次加载页面时，将调用一次大小调整观察器，然后应用渐变。

Now, the magic happens when we add the following JavaScript code:

现在，当我们添加以下JavaScript代码时，魔术就发生了：

Here we’re iterating over the entries in the observer’s callback using a [for…of][for_of] loop, but calling `forEach` on the entries would work just the same.

在这里，我们使用[for…of][for_of]循环遍历观察者回调中的条目 ，但是在条目上调用`forEach`相同。

Notice how we also have to iterate over the elements that we can to observe and call `observe` on each element.

注意，我们还必须遍历可以观察的元素，并在每个元素上调用`observe` 。

## 浏览器支持 **(**Browser Support**)** ##

Browser support right now is pretty bad, with only Chrome 64+ supporting Resize Observer out of the box. Thankfully, [there’s a polyfill][there_s a polyfill] we can use in the mean time. The polyfill is based on the [MutationObserver API][].

目前，浏览器支持非常糟糕，只有Chrome 64+支持开箱即用的Resize Observer。 值得庆幸的是，在此期间我们可以使用[一个polyfill][there_s a polyfill] 。 该polyfill基于[MutationObserver API][] 。

You can visit [Can I Use resizeobserver?][Can I Use resizeobserver] to track support for this feature across the major browsers.

您可以访问[我可以使用resizeobserver吗？][Can I Use resizeobserver] 跟踪主要浏览器对此功能的支持。

> 翻译自: [https://www.digitalocean.com/community/tutorials/js-resize-observer][https_www.digitalocean.com_community_tutorials_js-resize-observer]

resize

[Resize Observer]: https://wicg.github.io/ResizeObserver/
[Intersection Observer API]: https://www.digitalocean.com/community/tutorials/js-intersection-observer
[for_of]: https://www.digitalocean.com/community/tutorials/js-for-of-for-in-loops
[there_s a polyfill]: https://github.com/que-etc/resize-observer-polyfill
[MutationObserver API]: https://developer.mozilla.org/en-US/docs/Web/API/MutationObserver
[Can I Use resizeobserver]: http://caniuse.com/#feat=resizeobserver
[https_www.digitalocean.com_community_tutorials_js-resize-observer]: https://www.digitalocean.com/community/tutorials/js-resize-observer