exit-intent-quattro/README.md

Exit intent detection library - detects all 4 edges.

# Exit Intent Quattro

[![version][version]](http://npm.im/exit-intent)
[![MIT License][mit license]](http://opensource.org/licenses/MIT)
[![Standard][standard]](http://standardjs.com)
[![Standard Version][standard version]](https://github.com/conventional-changelog/standard-version)
[![Size][size]](https://unpkg.com/exit-intent)
[![Size gzip][size gzip]](https://unpkg.com/exit-intent)

Exit Intent detection library based on [Dan Hayden](https://github.com/danhayden/exit-intent)'s original version. This library builds on top of the original version by adding edge detection on all 4 edges of the viewport instead of just the top.

## Usage

```js
import exitIntent from 'exit-intent-quattro';

// Initialise
const removeExitIntent = exitIntent({
  edges: {
    top: true,
    right: true,
    bottom: true,
    left: true,
  },
  threshold: 20,
  maxDisplays: 2,
  eventThrottle: 100,
  onExitIntent: ({side, position: {x, y}}) => {
    console.log(`exit-intent triggered on ${side} side at position ${x}, ${y}`);
  },
});

// Destroy
removeExitIntent();
```

### Options

`edges` (default `{top: true, right: false, bottom: false, left: false}`)  
edges of the viewport that triggers exit intent.

`threshold` (default 20)  
maximum distance in pixels from the top of the page to trigger.

`maxDisplays` (default 1)  
maximum number of times to trigger.

`eventThrottle` (default 200)  
event throttle in milliseconds.

`onExitIntent` (default no-op function)  
function to call when an exit intent has been detected. An object will be passed in with these properties (see example above):
* `side`
  * string with possible values: `top`, `right`, `bottom`, and `left`
* `position`
  * object with `x` and `y` numeric properties indicating the position at which exit intent was detected

### License

MIT

[version]: https://img.shields.io/npm/v/exit-intent.svg
[mit license]: https://img.shields.io/npm/l/exit-intent.svg
[standard]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg
[standard version]: https://img.shields.io/badge/release-standard%20version-brightgreen.svg
[size]: https://badges.herokuapp.com/size/npm/exit-intent
[size gzip]: https://badges.herokuapp.com/size/npm/exit-intent?gzip=true

originally based on https://github.com/richriscunha/Exitent