# vue-scroller-loading

> Vue component for smooth scroll, pull to refresh & infinite loading.

Latest version **1.0.5** (published 2019-10-24) · MIT license · 0 weekly downloads

## Install

```sh
npm install vue-scroller-loading
pnpm add vue-scroller-loading
yarn add vue-scroller-loading
bun add vue-scroller-loading
```

## 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.5 |
| Published | 2019-10-24 |
| First published | 2019-10-23 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 1.9 MB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Author | lzyerliu |
| Maintainers | lzyerliu |
| Keywords | vue, scroll, scroll loading more, pull-to-refresh, pull to refresh, pulltorefresh, infinite load |

## Links

- npm: https://www.npmjs.com/package/vue-scroller-loading
- Repository: https://github.com/lzyerliu/vue-scroller-loading
- Issues: https://github.com/lzyerliu/vue-scroller-loading/issues
- npm.io page: https://npm.io/package/vue-scroller-loading

## Dependencies (2)

- [vue](https://npm.io/package/vue.md) ^2.6.10
- [vue-router](https://npm.io/package/vue-router.md) ^3.1.3

## Recent versions

- 1.0.5 (latest) — 2019-10-24
- 1.0.4 — 2019-10-23
- 1.0.3 — 2019-10-23
- 1.0.2 — 2019-10-23
- 1.0.1 — 2019-10-23
- 1.0.0 — 2019-10-23

## README

# vue-scroller-loading ![vue](https://img.shields.io/badge/vue-%20v2.x%20-green.svg)

[Vue Scroller Loading](https://github.com/lzyerliu/vue-scroller-loading) support smooth scroll, pull to refresh & infinite loading.

## Reference

See also [Vue-Scroller](https://github.com/wangdahoo/vue-scroller) doing recursion instead of timer(setInterval) to improve performance.

## Demo

[https://lzyerliu.github.io/vue-scroller-loading](https://lzyerliu.github.io/vue-scroller-loading/doc/index.html)

## Usage

``` bash
# install
npm install vue-scroller-loading -S (or cnpm install vue-scroller-loading -S)
```

```js
/* ignore this if you include vue-scroller.js by <script> tag from a cdn, such as unpkg */
import Vue from 'vue'
import Scroller from 'vue-scroller-loading'
Vue.use(Scroller)
```

```html
<scroller
  :on-refresh="refresh"
  :on-infinite="infinite"
> 
  <!-- content to here -->
</scroller>
```

## API

#### vue-scroller-loading component attributes:

| Attr. Name | Description | Required | Default Value |
|-----|-----|-----|-----|
| onRefresh | pull to refresh callback | N | - |
| onInfinite | infinite loading callback | N | - |
| refreshText | tips of `pull-to-refresh` | N | 下拉刷新 |
| releaseText | tips of `pull-to-refresh` | N | 松开更新 |
| noDataText | tips of `no-more-data` when `infinite-loading` finished | N | 没有更多数据 |
| width | scroller container width | N | `100%` |
| height | scroller container height | N | `100%` |
| snapping | enable snapping mode | N | `false` |
| snappingWidth | snapping width | N | 100 (stand for 100px) |
| snappingHeight | snapping height | N | 100 |
| refreshLayerColor | text color of `pull-to-refresh` layer | N | #999 |
| loadingLayerColor | text color of `infinite-loading` layer | N | #999 |
| minContentHeight | min content height (px) of `scroll-content` | N | 0 |

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