Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →

element-resize-detector

Package Overview

Dependencies

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

element-resize-detector

resize event emitter for elements.

0.3.1
Source
npm

Version published: 10 years ago

Maintainers: 1

Created: 10 years ago

What is element-resize-detector?

The element-resize-detector npm package is a utility for detecting changes in the size of HTML elements. It provides a way to listen for resize events on any DOM element, which can be useful for responsive design, dynamic content adjustments, and more.

What are element-resize-detector's main functionalities?

Basic Resize Detection

This feature allows you to listen for resize events on a specific DOM element. When the element is resized, the provided callback function is executed.

const elementResizeDetectorMaker = require('element-resize-detector');
const erd = elementResizeDetectorMaker();

const element = document.getElementById('myElement');
erd.listenTo(element, function(element) {
  console.log('Element resized:', element);
});

Unlisten to Resize Events

This feature allows you to stop listening to resize events on a specific DOM element. This can be useful for cleanup or when the resize detection is no longer needed.

const elementResizeDetectorMaker = require('element-resize-detector');
const erd = elementResizeDetectorMaker();

const element = document.getElementById('myElement');

function onResize(element) {
  console.log('Element resized:', element);
}

erd.listenTo(element, onResize);

// Later, if you want to stop listening to resize events
erd.uninstall(element);

Batch Listening

This feature allows you to listen for resize events on multiple elements at once. The provided callback function is executed whenever any of the elements are resized.

const elementResizeDetectorMaker = require('element-resize-detector');
const erd = elementResizeDetectorMaker();

const elements = document.querySelectorAll('.resize-listen');

function onResize(element) {
  console.log('Element resized:', element);
}

elements.forEach(element => erd.listenTo(element, onResize));

Other packages similar to element-resize-detector

element-resize-detector

Cross-browser resize event emitter for elements.

npm install element-resize-detector

Include script

Include the script in the browser:

<!DOCTYPE hml>
<html>
    <head></head>
    <body>
        <script src="node_modules/element-resize-detector/dist/element-resize-detector.min.js"></script>
    </body>
</html>

This will create a global function elementResieDetectorMaker, which is the maker function that makes an element resize detector instance.

You can also require it like so:

var elementResizeDetectorMaker = require("element-resize-detector");

Create instance

//With default options.
var erdDefault = elementResizeDetectorMaker();

API

listenTo(element, listener)

Listens to the element for resize events and calls the listener function with the element as argument on resize events.

Example usage:

erd.listenTo(document.getElementById("test"), function(element) {
  //Should probably use jQuery for the width and height for compability.
  var width = element.offsetWidth;
  var height = element.offsetHeight;
  console.log("Size: " + width + "x" + height);
});

Caveats:

If the element has display: static it will be changed to display: relative. This means if you have unintentional top/right/bottom/left styles on the element (which was ignored when being static) they will now be applied to the element. This will also mean that if there are any elements with position: absolute as children to the element, they will now be positioned relative to the element.
An <object> element will be injected as a direct child to the element. It has position: absolute so it will not affect the page flow. It is also visibly hidden.

FAQs

What is element-resize-detector?

Is element-resize-detector well maintained?

Package last updated on 13 Apr 2015

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install