CrazySquirrel/ViewAbility

# ViewAbility

[![npm version](https://badge.fury.io/js/ViewAbility.svg)](https://github.com/CrazySquirrel/ViewAbility)
[![Code Climate](https://codeclimate.com/github/CrazySquirrel/ViewAbility/badges/gpa.svg)](https://codeclimate.com/github/CrazySquirrel/ViewAbility)
[![Test Coverage](https://codeclimate.com/github/CrazySquirrel/ViewAbility/badges/coverage.svg)](https://codeclimate.com/github/CrazySquirrel/ViewAbility/coverage)
[![Issue Count](https://codeclimate.com/github/CrazySquirrel/ViewAbility/badges/issue_count.svg)](https://codeclimate.com/github/CrazySquirrel/ViewAbility)
[![Donate](https://img.shields.io/badge/donate-%E2%99%A5-red.svg)](http://crazysquirrel.ru/support/)

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

```TypeScript
import ViewAbility from "ViewAbility.ts";

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

or

```JavaScript
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.