Skip to content

Commit 9eaa126

Browse files
committed
Update readme
1 parent a436841 commit 9eaa126

File tree

1 file changed

+21
-17
lines changed

1 file changed

+21
-17
lines changed

README.md

Lines changed: 21 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -147,39 +147,27 @@ More usages or getting start you can refer to these clearly [examples](https://g
147147
<td>{}</td>
148148
<td>Extra props assign to item component.</td>
149149
</tr>
150-
<tr>
151-
<td><code>start</code></td>
152-
<td>Number</td>
153-
<td>0</td>
154-
<td>Setting scroll stay start index.</td>
155-
</tr>
156-
<tr>
157-
<td><code>offset</code></td>
158-
<td>Number</td>
159-
<td>0</td>
160-
<td>Setting scroll stay offset.</td>
161-
</tr>
162150
<tr>
163151
<td><code>scroll</code></td>
164-
<td>Function</td>
152+
<td>Event</td>
165153
<td></td>
166154
<td>Emited when scrolling, param <code>(event, range)</code>.</td>
167155
</tr>
168156
<tr>
169157
<td><code>totop</code></td>
170-
<td>Function</td>
158+
<td>Event</td>
171159
<td></td>
172160
<td>Emited when scrolled to top or left, param <code>(event, range)</code>.</td>
173161
</tr>
174162
<tr>
175163
<td><code>tobottom</code></td>
176-
<td>Function</td>
164+
<td>Event</td>
177165
<td></td>
178166
<td>Emited when scrolled to bottom or right, param <code>(event, range)</code>.</td>
179167
</tr>
180168
<tr>
181169
<td><code>resized</code></td>
182-
<td>Function</td>
170+
<td>Event</td>
183171
<td></td>
184172
<td>Emited when each item resized (mounted), param <code>(id, size)</code>.</td>
185173
</tr>
@@ -191,11 +179,23 @@ More usages or getting start you can refer to these clearly [examples](https://g
191179
<p></p>
192180
<table>
193181
<tr>
194-
<th>Props</th>
182+
<th>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Props&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</th>
195183
<th>Type</th>
196184
<th>Default</th>
197185
<th>Description</th>
198186
</tr>
187+
<tr>
188+
<td><code>start</code></td>
189+
<td>Number</td>
190+
<td>0</td>
191+
<td>Setting scroll stay start index.</td>
192+
</tr>
193+
<tr>
194+
<td><code>offset</code></td>
195+
<td>Number</td>
196+
<td>0</td>
197+
<td>Setting scroll stay offset.</td>
198+
</tr>
199199
<tr>
200200
<td><code>root-tag</code></td>
201201
<td>String</td>
@@ -287,6 +287,10 @@ Here are some usefull public methods you can call via [`ref`](https://vuejs.org/
287287

288288
* `getSizes()`: get the total number of stored (rendered) items.
289289

290+
* `getClientSize()`: get wrapper client viewport size (width or height).
291+
292+
* `getScrollSize()`: get all scroll size (scrollHeight or scrollWidth).
293+
290294

291295
## Attentions
292296

0 commit comments

Comments
 (0)