Skip to content
This repository was archived by the owner on Nov 5, 2023. It is now read-only.

Commit 02ef13d

Browse files
committed
docs: clarify pageNumber
1 parent c3787c6 commit 02ef13d

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -29,13 +29,13 @@ npm install vue-virtual-scroll-grid
2929

3030
## Available Props
3131

32-
| Name | Description | Type | Validation |
33-
| -------------------------- | ------------------------------------------------------------------------- | -------------------------------------------------------------- | ---------------------------------------------------- |
34-
| `length` | The number of items in the list | `number` | Required, an integer greater than or equal to 0 |
35-
| `pageProvider` | The callback that returns a page of items as a promise | `(pageNumber: number, pageSize: number) => Promise<unknown[]>` | Required |
36-
| `pageProviderDebounceTime` | Debounce window in milliseconds on the calls to `pageProvider` | `number` | Optional, an integer greater than or equal to 0 |
37-
| `pageSize` | The number of items in a page from the item provider (e.g. a backend API) | `number` | Required, an integer greater than or equal to 1 |
38-
| `scrollTo` | Scroll to a specific item by index | `number` | Optional, an integer from 0 to the `length` prop - 1 |
32+
| Name | Description | Type | Validation |
33+
| -------------------------- |-----------------------------------------------------------------------------------| -------------------------------------------------------------- | ---------------------------------------------------- |
34+
| `length` | The number of items in the list | `number` | Required, an integer greater than or equal to 0 |
35+
| `pageProvider` | The callback that returns a page of items as a promise. `pageNumber` start with 0 | `(pageNumber: number, pageSize: number) => Promise<unknown[]>` | Required |
36+
| `pageProviderDebounceTime` | Debounce window in milliseconds on the calls to `pageProvider` | `number` | Optional, an integer greater than or equal to 0 |
37+
| `pageSize` | The number of items in a page from the item provider (e.g. a backend API) | `number` | Required, an integer greater than or equal to 1 |
38+
| `scrollTo` | Scroll to a specific item by index | `number` | Optional, an integer from 0 to the `length` prop - 1 |
3939

4040
Example:
4141

0 commit comments

Comments
 (0)