# vue-cooler-exposure

> [![npm version](https://img.shields.io/npm/v/vue-cooler-exposure.svg?style=flat-square)](https://www.npmjs.com/package/vue-cooler-exposure) [![npm downloads](https://img.shields.io/npm/dm/vue-cooler-exposure.svg?style=flat-square)](https://www.npmjs.com/p

Latest version **1.0.2** (published 2020-12-25) · MIT license · 2 weekly downloads

## Install

```sh
npm install vue-cooler-exposure
pnpm add vue-cooler-exposure
yarn add vue-cooler-exposure
bun add vue-cooler-exposure
```

## Health

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

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score; declining downloads.

## Facts

| | |
|---|---|
| Version | 1.0.2 |
| Published | 2020-12-25 |
| First published | 2020-12-22 |
| Weekly downloads | 2 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >=10 |
| Dependencies | 0 |
| Unpacked size | 41.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | ningshuai |
| Maintainers | sh.ning |
| Keywords | vue, exposure, exposure check, record, data record, data report |

## Links

- npm: https://www.npmjs.com/package/vue-cooler-exposure
- Repository: https://github.com/shnning/vue-cooler-exposure
- Homepage: https://github.com/shnning/vue-cooler-exposure#readme
- Issues: https://github.com/shnning/vue-cooler-exposure/issues
- npm.io page: https://npm.io/package/vue-cooler-exposure

## Recent versions

- 1.0.2 (latest) — 2020-12-25
- 1.0.1 — 2020-12-25
- 1.0.0 — 2020-12-22

## README

# vue-cooler-exposure

[![npm version](https://img.shields.io/npm/v/vue-cooler-exposure.svg?style=flat-square)](https://www.npmjs.com/package/vue-cooler-exposure)
[![npm downloads](https://img.shields.io/npm/dm/vue-cooler-exposure.svg?style=flat-square)](https://www.npmjs.com/package/vue-cooler-exposure)
[![npm license](https://img.shields.io/npm/l/vue-cooler-exposure?style=flat-square)](https://www.npmjs.com/package/vue-cooler-exposure)
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)

[中文说明](./README-CN.md)

A vue plugin used to exposure elements and record data. Here are the advantages:
- Be lighterweight, just do one thing is that exposure elements
- use the browser native API Intersectionobserver, better performance
- offer hooks which you can deal with the data of elements exposured

## Demo
```bash
npm install
npm run dev
```

## Requirements
- Vue 2.x


## Installation
### npm
```bash
npm install vue-cooler-exposure
```


## Usage
main.js:
```javascript
import Vue from 'vue';
import exposurePlugin from 'vue-cooler-exposure';

Vue.use(lazyloadPlugin);
// you can get $exposure in the prototype of Vue and Vue instance.
// register callback which would be called when visibility of some element has changed.
Vue.prototype.$exposure.addAfterRecordCallback
(exposureList => {
  console.log(exposureList);
  // upload exposureList or some ...
})
```

template:
```html
<div>
  <img v-exposure="data1" />
  <div v-exposure="data2"></div>
</div>
```
v-exposure would set the data, which you could get it in the callback args, in the element.


## Plugin Options
|key|description|default|options|
|---|-----------|-------|-------|
|border|the viewport you want to listen|{top: 0, bottom: 0, left: 0, right: 0}(window)|{top, bottom, left, right}|
|threshold|the proportion of element insert into viewport|1(1 means that when a whole element go into the viewport, callback would be excuted)|0~1|
|delay|a delay time for debounce(unit: ms)|800|number|

## APIs
|key|description|default param|type|
|---|-----------|-------|-------|
|addAfterRecordCallback|when visibility of some element has changed, it would be called and the arg is the list of data which elements in viewport take.|null|(exposureList): void|
|exposureCheck|call callback at once|no args|no args|

## Compatibility
The compatibility of this plugin depends on [compatibility of IntersectionObserver](https://caniuse.com/intersectionobserver)
## License
[MIT](./LICENSE)

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