Skip to main content

@rtorcato/browser-common / resizeobserver

resizeobserver

Functions​

observeResize()​

observeResize(element, callback, options?): ResizeObserver

Defined in: resizeobserver/index.ts:14

Creates a ResizeObserver and starts observing the given element.

Parameters​

element​

Element

The element to observe.

callback​

ResizeObserverCallback

The callback to run when the element is resized.

options?​

ResizeObserverOptions

Optional ResizeObserver options.

Returns​

ResizeObserver

The created ResizeObserver instance.

Example​

import { observeResize, disconnectResizeObserver } from '@rtorcato/browser-common/resizeobserver'
const obs = observeResize(panel, (entries) => console.log(entries[0]?.contentRect))
disconnectResizeObserver(obs)

disconnectResizeObserver()​

disconnectResizeObserver(observer): void

Defined in: resizeobserver/index.ts:33

Disconnects a ResizeObserver, stopping all observations.

Parameters​

observer​

ResizeObserver

The ResizeObserver instance.

Returns​

void

Example​

import { disconnectResizeObserver } from '@rtorcato/browser-common/resizeobserver'
disconnectResizeObserver(obs)

observeResizeOnce()​

observeResizeOnce(element, callback, options?): ResizeObserver

Defined in: resizeobserver/index.ts:49

Utility to observe an element for resize once (fires callback only on first resize).

Parameters​

element​

Element

The element to observe.

callback​

ResizeObserverCallback

The callback to run on first resize.

options?​

ResizeObserverOptions

Optional ResizeObserver options.

Returns​

ResizeObserver

The created ResizeObserver instance.

Example​

import { observeResizeOnce } from '@rtorcato/browser-common/resizeobserver'
observeResizeOnce(panel, () => console.log('first resize'))