Skip to content

Commit 2e662d6

Browse files
committed
Update readme.
1 parent aca4fe4 commit 2e662d6

File tree

1 file changed

+15
-6
lines changed

1 file changed

+15
-6
lines changed

README.md

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,11 @@
77
<a href="https://github.com/tangbc/vue-virtual-scroll-list/blob/master/LICENSE">
88
<img src="https://img.shields.io/github/license/tangbc/vue-virtual-scroll-list.svg" alt="MIT License"/>
99
</a>
10+
<br/>
11+
<a href="https://github.com/tangbc/vue-virtual-scroll-list/blob/master/LICENSE">
12+
<img src="https://nodei.co/npm/vue-virtual-scroll-list.png?downloads=true&downloadRank=true&stars=true" alt="NPM Info"/>
13+
</a>
14+
1015

1116
## vue-virtual-scroll-list
1217

@@ -26,14 +31,14 @@
2631
<img src="https://tangbc.github.io/github-images/virtual-scroll-list-2.gif">
2732

2833

29-
## Demos
34+
## Live demos
3035

3136
* [vue-virtual-scroll-list with 100,000 finite data](https://tangbc.github.io/vue-virtual-scroll-list/examples/finite/).
3237

3338
* [vue-virtual-scroll-list infinite data by request 20 each time](https://tangbc.github.io/vue-virtual-scroll-list/examples/infinite/).
3439

3540

36-
## Usage
41+
## Simple usage
3742

3843
#### Using by npm:
3944

@@ -96,7 +101,7 @@ new Vue({
96101
**Notice: list Item component or DOM frag using `v-for` must designate the `:key` property.**
97102

98103

99-
## Props
104+
## Props type
100105

101106
*Prop* | *Type* | *Required* | *Description* |
102107
:--- | :--- | :--- | :--- |
@@ -105,16 +110,20 @@ new Vue({
105110
| start | Number | * | Default value is `0`, the initial scroll start index. It must be integer and in the range of list index, do nothing but throw a warnning if not match. |
106111
| rtag | String | * | Default value is `div`, the virtual-list's root HTMLElement tag name, in all case it's style is set to `display: block;` |
107112
| wtag | String | * | Default value is `div`, the virtual-list's item wrapper HTMLElement tag name, in all case it's style is set to `display: block;` |
108-
| onscroll | Function | * | Call on virtual-list scroll event hanlding, param: `(e, scrollTop)`. |
109-
| totop | Function | * | A function triggered when the virtual-list is scrolled to top. |
110-
| tobottom | Function | * | A function triggered when the virtual-list is scrolled to bottom. |
113+
| onscroll | Function | * | Called when virtual-list scroll event hanlding, param: `(e, scrollTop)`. |
114+
| totop | Function | * | Called when the virtual-list is scrolled to top. |
115+
| tobottom | Function | * | Called when the virtual-list is scrolled to bottom. |
111116

112117

113118
## Contributions
114119

115120
Welcome to improve vue-virtual-scroll-list by any pull request or issue.
116121

117122

123+
## Changelogs
124+
125+
See [releasese](https://github.com/tangbc/vue-virtual-scroll-list/releases).
126+
118127
## License
119128

120129
[MIT License](https://github.com/tangbc/vue-virtual-scroll-list/blob/master/LICENSE)

0 commit comments

Comments
 (0)