# v-scroll-list

> The vue list component that can pull down to refresh and scroll to loading

Latest version **1.0.1** (published 2017-02-25) · ISC license · 0 weekly downloads

## Install

```sh
npm install v-scroll-list
pnpm add v-scroll-list
yarn add v-scroll-list
bun add v-scroll-list
```

## 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.1 |
| Published | 2017-02-25 |
| First published | 2017-02-20 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 2 |
| Author | OliverY1992 |
| Maintainers | olivery |
| Keywords | vue, scroll |

## Links

- npm: https://www.npmjs.com/package/v-scroll-list
- Repository: https://github.com/oliverY1992/v-scroll-list
- Homepage: https://github.com/oliverY1992/v-scroll-list#readme
- Issues: https://github.com/oliverY1992/v-scroll-list/issues
- npm.io page: https://npm.io/package/v-scroll-list

## Dependencies (1)

- [vue](https://npm.io/package/vue.md) ^2.1.10

## Recent versions

- 1.0.1 (latest) — 2017-02-25
- 1.0.0 — 2017-02-25
- 0.4.0 — 2017-02-23
- 0.3.0 — 2017-02-23
- 0.2.0 — 2017-02-23
- 0.1.0 — 2017-02-20

## README

# v-scroll-list 0.1.0
A vue component that pull down to refresh and scroll to load more in mobile 
## Basic Usage
```
import Vue from 'vue';
import scroller from 'v-scroll-list';
 new Vue({
    props:{
      listData:Array
    },
    components:{
      scroller
    },
    methods:{
      onRefresh(done){
        /**
          your code: triggered when list is refreshing
        */
        //done() will cease refreshing
        done();
      },
      onInfinite(done){
        /**
          your code: triggered when list is on end of current list
        */
        done();
      }
    },
    template:'<scroller><ul><li v-for="item in listData"></li></ul></scroller>'
 })
```
## Props
|     prop      |   type    |   default   |           description             |
|---------------|:----------|:------------|:----------------------------------|
|    offset     |  Number   |     44      | the threshold of refreshing layer |
|   downText    |  String   |  '下拉刷新' |  the tip of pulling                |
|   uptext      |  String   |  '释放刷新' |  the tip of holding                |
|  refreshText  |  String   |  '刷新中...'|  the tip of refreshing             |
|   onRefresh   |  Function |  undefined  |                                   |
|   onInfinite  |  Function |  undefined  |                                   |

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