README.md

Fyzer

The easiest way to be notified when some element appears above the page fold

Installation

$ npm install -S @glorious/fyzer

Usage

import fyzer from '@glorious/fyzer';

const element = document.querySelector('#myElement');

const subscriptionId = fyzer.subscribe(element, () => {
  // This function will be called every time
  // element appears above the fold.
});

// When you no longer needs to observe the element's position,
// you can unsubscribe from Fyzer:
fyzer.unsubscribe(subscriptionId);

Contributing

1. Install Node. Download the "Recommend for Most Users" version.

2. Clone the repo:

git clone [email protected]:glorious-codes/glorious-fyzer.git

3. Go to the project directory:

cd glorious-fyzer

4. Install the project dependencies:

npm install

Tests

Ensure that all code that you have added is covered with unit tests:

npm run test -- --coverage