# @huteming/ui-infinite-scroll

> 无限滚动指令

Latest version **4.0.0** (published 2020-02-05) · ISC license · 0 weekly downloads

## Install

```sh
npm install @huteming/ui-infinite-scroll
pnpm add @huteming/ui-infinite-scroll
yarn add @huteming/ui-infinite-scroll
bun add @huteming/ui-infinite-scroll
```

## 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 | 4.0.0 |
| Published | 2020-02-05 |
| First published | 2020-02-05 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 785 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | huteming |

## Links

- npm: https://www.npmjs.com/package/@huteming/ui-infinite-scroll
- npm.io page: https://npm.io/package/@huteming/ui-infinite-scroll

## Recent versions

- 4.0.0 (latest) — 2020-02-05

## README

> 无限滚动指令。

-------------

## 引入

```javascript
import { InfiniteScroll } from '@huteming/ui'

Vue.use(InfiniteScroll)
// Vue.directive(InfiniteScroll.name, InfiniteScroll)
```

## 例子

为 HTML 元素添加 `v-infinite-scroll` 指令即可使用无限滚动。滚动该元素，当其底部与被滚动元素底部的距离小于给定的阈值时，绑定到 `v-infinite-scroll` 指令的方法就会被触发。

```html
<ul v-infinite-scroll="loadMore">
    <li v-for="item in list">{{ item }}</li>
</ul>
```

```javascript
loadMore (done) {
    setTimeout(() => {
        let last = this.list[this.list.length - 1]

        for (let i = 1; i <= 10; i++) {
            this.list.push(last + i)
        }

        done()
    }, 2500)
}
```

## API

| 参数 | 说明 | 类型 | 可选值 | 默认值 |
|------|-------|---------|-------|--------|
| callback | 触发的回调函数。指令参数是function类型时，作为callback | Function(done) | | |
| distance | 触发加载方法的滚动距离阈值（像素）） | Number | | `50` |
| disabled | 若为真，则无限滚动不会被触发 | Boolean | | `false` |

## 修饰符

| 参数 | 说明 | 默认值 |
|--------|-----------|--------|
| immediate | 若为真，则指令被绑定到元素上后会立即检查是否需要执行加载方法。在初始状态下内容有可能撑不满容器时十分有用 | `false` |

## 监听事件

| 事件名称 | 说明 | 示例 |
|--------|-----------|--------|
| `infinite-scroll` | 一个 event，被执行时会立即检查是否需要执行加载方法 | this.$emit('infinite-scroll') |

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