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.

Example

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

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.


disconnectResizeObserver()

disconnectResizeObserver(observer): void

Defined in: resizeobserver/index.ts:33

Disconnects a ResizeObserver, stopping all observations.

Example

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

Parameters

observer

ResizeObserver

The ResizeObserver instance.

Returns

void


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).

Example

import { observeResizeOnce } from '@rtorcato/browser-common/resizeobserver'
observeResizeOnce(panel, () => console.log('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.