viewability-helper
DefinitelyTyped icon, indicating that this package has TypeScript declarations provided by the separate @types/viewability-helper package

1.0.27 • Public • Published

ViewabilityHelper

Build Status npm version

Lightweight cross-browser library that enables you to create a watcher for a given element, and get back a callback when it has entered the viewport

It uses Intersection Observer API if available, and if not, it calculates it by itself.

Browser support for the Intersection Observer API can be found here.

Not working when Intersection Observer is not supported and the script is running inside an iframe.

Written in ES6 and compiled to ES5 using Babel.

Install

npm install --save viewability-helper

Usage

// import the module
import ViewabilityHelper from 'viewability-helper';
// -or-
const ViewabilityHelper = require('viewability-helper');
 
// Create a new observer for an element with a callback function
const myObserver = new ViewabilityHelper(element, callback);
// Fire in the hole!
myObserver.observe();
 
// With options
myObserver = new ViewabilityHelper(element, callback, {callbackParams: ['Element number 1']});
 

Options

callbackParams (Array) - List of parameters passed to the callback function

intersectPercentage (String) - Intersection percentage, ex: "0", "0.2" etc..

scrollDimmer (Integer) - Interval for triggering element viewability watch (msec)

unobserve (Boolean) - Should the observer keep observing the element after first viewability event or not

rootMargin (String) - For Intersection Observer API, The root element margin

threshold (Array) - For Intersection Observer API, List of intersection ratio thresholds of the element with the viewport

Contribute

Please first fork this repository, make your changes and then create a pull request.

Start by

npm install

And then build it with

npm run dev

Package Sidebar

Install

npm i viewability-helper

Weekly Downloads

17

Version

1.0.27

License

MIT

Last publish

Collaborators

  • lironzluf