# wj-scroll-block

> > 监听window的滚动事件，当被监听的DOM出现在屏幕的相应位置时，触发回调函数，回调函数的参数由{offsetTop, offsetTopHeight, index} > offsetTop是此DOM元素距离文档顶部的距离 > offsetTopHeight是此DOM元素距离文档顶部的距离加上偏移量 > index是当前被监听DOM元素的索引

Latest version **1.0.2** (published 2020-09-30) · ISC license · 0 weekly downloads

## Install

```sh
npm install wj-scroll-block
pnpm add wj-scroll-block
yarn add wj-scroll-block
bun add wj-scroll-block
```

## Health

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

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

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.2 |
| Published | 2020-09-30 |
| First published | 2020-09-30 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 4.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | wjjack |
| Maintainers | wjjack |
| Keywords | scroll, typscript |

## Links

- npm: https://www.npmjs.com/package/wj-scroll-block
- Repository: https://github.com/WJjack/wj-scroll-block
- Homepage: https://github.com/WJjack/wj-scroll-block#readme
- Issues: https://github.com/WJjack/wj-scroll-block/issues
- npm.io page: https://npm.io/package/wj-scroll-block

## Recent versions

- 1.0.2 (latest) — 2020-09-30
- 1.0.1 — 2020-09-30
- 1.0.0 — 2020-09-30

## README

### 描述
> 监听window的滚动事件，当被监听的DOM出现在屏幕的相应位置时，触发回调函数，回调函数的参数由{offsetTop, offsetTopHeight, index}
> offsetTop是此DOM元素距离文档顶部的距离
> offsetTopHeight是此DOM元素距离文档顶部的距离加上偏移量
> index是当前被监听DOM元素的索引

### 安装
`npm i wj-scroll-block -S`

### 类DomBlockWatcher
> 构造器参数 classname 是css类名，如.tilte
> 构造器参数 offsetTopNum 是指顶部的偏移量，比如顶部有导航栏高度为50px，则偏移量为-50

### 使用方式
```javascript
import DomBlockWatcher from 'wj-scroll-block';
new DomBlockWatcher('.title', -100).watch((domInfo) => {
    console.log(domInfo);
});
```

### 源码地址
<https://github.com/WJjack/wj-scroll-block.git>

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