# viewport-events

> Enable viewport events for DOM-elements: enteredView, leftView

Latest version **1.0.2** (published 2015-04-06) · unlicense license · 0 weekly downloads

## Install

```sh
npm install viewport-events
pnpm add viewport-events
yarn add viewport-events
bun add viewport-events
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.2 |
| Published | 2015-04-06 |
| First published | 2015-04-06 |
| Weekly downloads | 0 |
| License | unlicense |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | dfcreative |
| Maintainers | dfcreative |
| Keywords | viewport, DOM, dom-events, enteredView, customElements |

## Links

- npm: https://www.npmjs.com/package/viewport-events
- Repository: https://github.com/kudago/viewport
- Issues: https://github.com/kudago/viewport/issues
- npm.io page: https://npm.io/package/viewport-events

## Dependencies (3)

- [emmy](https://npm.io/package/emmy.md) >=3.1.0
- [intersects](https://npm.io/package/intersects.md) *
- [tiny-element](https://npm.io/package/tiny-element.md) *

## Alternatives

- [babylon](https://npm.io/package/babylon.md) — 5.1M weekly downloads
- [csscolorparser](https://npm.io/package/csscolorparser.md) — 3.7M weekly downloads
- [expr-eval-fork](https://npm.io/package/expr-eval-fork.md) — 1.5M weekly downloads
- [@leeoniya/ufuzzy](https://npm.io/package/@leeoniya/ufuzzy.md) — 247.7K weekly downloads
- [xml-parser](https://npm.io/package/xml-parser.md) — 78.4K weekly downloads

## Recent versions

- 1.0.2 (latest) — 2015-04-06
- 1.0.1 — 2015-04-06
- 1.0.0 — 2015-04-06
- 0.3.3 — 2015-04-06

## README

## Viewport events [![Code Climate](https://codeclimate.com/github/kudago/viewport-events/badges/gpa.svg)](https://codeclimate.com/github/kudago/viewport-events) <a href="UNLICENSE"><img src="http://upload.wikimedia.org/wikipedia/commons/6/62/PD-icon.svg" width="20"/></a>


Enable viewport events for HTML elements: `enteredView`, `leftView`.


## Usage

`$ npm install viewport-events`


```js
	var vpEvents = require('viewport-events');

	//enable viewport events for all elements on the page
	vpEvents.enable();
	$('.my-element').on('leftView', function(){});
	$('.my-other-element').on('enteredView', function(){});

	//Disable all viewport events
	vpEvents.disable();


	//Enable viewport events for a Node/NodeList
	vpEvents.enable(element);
	element.addEventListener('enteredView', function(){});
	element.addEventListener('leftView', function(){});

	//Disable viewport events for the previously added element/selector
	vpEvents.disable(element);
```

## API

### vp.enable(selector)

Enable viewport events for an Element, NodeList or selector. If no selector specified, `'*'` is used.

### vp.disable(selector)

Disable viewport events for previously registered selector. If no selector specified, all viewport events are unbound.

### vp.enteredViewCallbackName

Callback name used for entering viewport event. `enteredView` is used by default.

### vp.leftViewCallbackName

Callback name used for leaving viewport event. `leftView` is used by default.


[![NPM](https://nodei.co/npm/viewport-events.png?downloads=true&downloadRank=true&stars=true)](https://nodei.co/npm/viewport-events/)

---
_Source: https://npm.io/package/viewport-events · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._