Skip to content

Commit 4690cb8

Browse files
committed
Update readme
1 parent 7a6494d commit 4690cb8

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ new Vue({
117117

118118
## Attentions
119119

120-
* Must assign the `:key` property on `<item>` component or DOM frag with `v-for` directive.
120+
* Must assign the `:key` property on `<item>` component or dom frag with `v-for` directive.
121121

122122
* Consider use `box-sizing: border-box` on `<item>` if you want absolutely correct scroll height.
123123

@@ -129,11 +129,11 @@ new Vue({
129129
*Prop* | *Type* | *Required* | *Description* |
130130
:--- | :--- | :--- | :--- |
131131
| size | Number || Each list item height, in variable height mode, this prop just use to calculate the virtual-list outside container viewport height. |
132-
| remain | Number || How many items should be shown in virtual-list viewport, so `size` and `remain` determine the outside container viewport height (size × remian). |
132+
| remain | Number || How many items should be shown in virtual-list viewport, so `size` and `remain` determine the outside container viewport height (`size × remian`). |
133+
| bench | Number | * | Default value is equal to `remain`, unreached items count, not show in virtual-list viewport but exist in real DOM, the larger the bench, the higher the scroll performance will achieved. |
133134
| start | Number | * | Default value is `0`, the initial scroll start index. It must be integer and in the range of list index, if invalid there will be effected as `0` or the last one. |
134135
| offset | Number | * | Default value is `0`, the initial scroll offset. If both `start` and `offset` are assigned at initialization, `start` is preferred. |
135-
| bench | Number | * | Default value is equal to `remain`, unreached items count, not show in virtual-list viewport but exist in real DOM, the larger the bench, the higher the scroll performance will achieved. |
136-
| debounce | Number | * | **It's disabled by default**, milliseconds of using `debounce` function to ensure scroll event doesn't fire so often that it bricks browser performance. |
136+
| debounce | Number | * | It's disabled by default, milliseconds of using `debounce` function to ensure scroll event doesn't fire so often that it bricks browser performance. |
137137
| rtag | String | * | Default value is `div`, the virtual-list root element tag name, in all cases it's style is set to `display: block;` |
138138
| wtag | String | * | Default value is `div`, the virtual-list item wrapper element tag name, in all cases it's style is set to `display: block;` |
139139
| wclass | String | * | Default value is an empty string, the virtual-list item wrapper element class, if assign this prop, you better **not** to change it's [CSS box model](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Box_Model/Introduction_to_the_CSS_box_model). |

0 commit comments

Comments
 (0)