Skip to content

CrazySquirrel/ViewAbility

master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
lib
 
 
 
 
src
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

ViewAbility

npm version Code Climate Test Coverage Issue Count Donate

Class to determine the visibility of the block.

Build

The repository contains pre-compiled files, but if you want to add your files and compile, then run the following commands in the repository folder.

  • npm install
  • npm run production

or

  • npm run development

The build required NodeJs version 6 or higher.

Usage

import ViewAbility from "ViewAbility.ts";

new ViewAbility(
    domBannerObject,
    {
        percentage: 0.5,
        time: 2000,
    },
    callback
);

or

let ViewAbility = required("ViewAbility.js");

new ViewAbility(
    domBannerObject,
    {
        percentage: 0.5,
        time: 2000,
    },
    callback
);
  • domBannerObject - DOM element
  • percentage - How much of the object should be visible (0-1)
  • time - The amount of time the object must be visible to called callback.
  • callback - A function which will be called after the object is seen.

About

Class to determine the visibility of the block

Resources

License

Stars

Watchers

Forks

Packages

No packages published