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

element-height-observer

Package Overview
Dependencies
Maintainers
1
Versions
9
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

element-height-observer

Allows you to add an efficient height listener to any dom element and execute a callback when its height changes

  • 0.0.9
  • latest
  • Source
  • npm
  • Socket score

Version published
Maintainers
1
Created
Source

Element height observer

This library allows you to add an observer for page or element height. Each time the page changes height, a callback will be called.

No dependencies, total library minified is less than 0.9 KB

Install

npm install element-height-observer --save

Use

Load the script:

<html>
    <head>
        <script src="node_modules/element-height-observer/dist/index.js"></script>
    </head>
</html>

Or import it:

var heightObserver = require('element-height-observer');
var registerHeightObserver = heightObserver.registerHeightObserver;
var unregisterHeightObserver = heightObserver.unregisterHeightObserver;

Or import it (ES6 modules notation):

import { registerHeightObserver, unregisterHeightObserver } from 'element-height-observer';

When the page has loaded, you can register the observer like this:

window.addEventListener('load', function () {
    var someElement = document.querySelector('#someElementId');
    registerHeightObserver(someElement, function () {
        // Your code that you want to execute when the element changes height
    })
});

You can only add one listener per element, otherwise the unregister mechanism won't work correctly.

var someElement = document.querySelector('#someElementId');
unregisterHeightObserver(someElement);

API

There are 2 functions available:

  • registerHeightObserver(elementToWatch, options?, callback)
  • unregisterHeightObserver(elementToStopWatching)

The options are optional and can currently only specify which dimension of the element it should watch for:

direction: 'horizontal' | 'vertical' | 'both'

The default is 'vertical'

The callback doesn't get passed any parameters:

callback: () => void

Inspiration

This library is inspired by a stackoverflow post by Jake

Keywords

FAQs

Package last updated on 30 Apr 2018

Did you know?

Socket

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

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc