Skip to content

Commit 7a6494d

Browse files
committed
Update readme.
1 parent f2f3377 commit 7a6494d

File tree

1 file changed

+25
-7
lines changed

1 file changed

+25
-7
lines changed

README.md

Lines changed: 25 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,25 @@
1111
<img src="http://npm.packagequality.com/shield/vue-virtual-scroll-list.svg?style=flat-square" alt="Package quality">
1212
</a>
1313

14+
##
1415

15-
## vue-virtual-scroll-list
16+
*If you are looking for a vue component which support big data list with high scroll performance, now you are in the right place!*
1617

17-
> If you are looking for a vue component which support big data list and high scroll performance, you are in the right place.
18+
* [Advantages](#advantages)
19+
* [Live demos](#live-demos)
20+
* [How it works](#how-it-works)
21+
* [Simple usage](#simple-usage)
22+
* [Using by npm module](#using-by-npm-module)
23+
* [Using by script include](#using-by-script-include)
24+
* [Attentions](#attentions)
25+
* [Props type](#props-type)
26+
* [Special scenes](#special-scenes)
27+
* [About variable height](#about-variable-height)
28+
* [Contributions](#contributions)
29+
* [Changelogs](#changelogs)
30+
31+
32+
## Advantages
1833

1934
* Tiny and very very easy to use.
2035

@@ -29,11 +44,11 @@
2944

3045
## Live demos
3146

32-
* [vue-virtual-scroll-list with 100,000 finite data](https://tangbc.github.io/vue-virtual-scroll-list/examples/finite/).
47+
* [Scroll with 100,000 finite data](https://tangbc.github.io/vue-virtual-scroll-list/examples/finite/).
3348

34-
* [vue-virtual-scroll-list with request infinite data](https://tangbc.github.io/vue-virtual-scroll-list/examples/infinite/).
49+
* [Scroll with request infinite data](https://tangbc.github.io/vue-virtual-scroll-list/examples/infinite/).
3550

36-
* [vue-virtual-scroll-list with variable height mode](https://tangbc.github.io/vue-virtual-scroll-list/examples/variable/).
51+
* [Scroll with variable height mode](https://tangbc.github.io/vue-virtual-scroll-list/examples/variable/).
3752

3853

3954
## How it works
@@ -43,7 +58,7 @@
4358

4459
## Simple usage
4560

46-
#### Using by npm:
61+
#### Using by npm module:
4762

4863
```
4964
npm install vue-virtual-scroll-list --save
@@ -100,7 +115,7 @@ new Vue({
100115
```
101116

102117

103-
## Notice
118+
## Attentions
104119

105120
* Must assign the `:key` property on `<item>` component or DOM frag with `v-for` directive.
106121

@@ -127,6 +142,9 @@ new Vue({
127142
| onscroll | Function | * | Called when virtual-list is scrolling, with param: [`(event, data)`](https://github.com/tangbc/vue-virtual-scroll-list/releases/tag/v1.1.7). |
128143
| variable | Function or Boolean | * | For using virtual-list with variable height mode. If assign `Function`, this prop is a variable height getter function which is called with param: `(index)` when each item is ready to be calculated. If assign `Boolean`, virtual-list will get each item variable height by it's inline style height automatic. |
129144

145+
146+
## Special scenes
147+
130148
### About variable height
131149

132150
In variable height mode, prop `size` is still required. All the index variable height and scroll offset will be cached by virtual-list after the binary-search calculate, if you want to change anyone `<item/>` height from data, you should call virtual-list's `updateVariable(index)` method to clear the offset cache, refer to [variable example](https://github.com/tangbc/vue-virtual-scroll-list/blob/master/examples/variable/variable.vue#L1) source for detail.

0 commit comments

Comments
 (0)