Skip to content

Commit a04c301

Browse files
attempt to improve readme on NPM
1 parent f4ad041 commit a04c301

1 file changed

Lines changed: 8 additions & 6 deletions

File tree

readme.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -36,14 +36,14 @@ Second, you can make use of the `useSearchAndPagination` hook. This package impl
3636
This hook supports the combination of a search value and pagination and manages the state of the search value, and the
3737
pagination values.
3838

39-
The hook supports following configuration parameter object:
39+
#### The hook supports following configuration parameter object:
4040

41-
|value|type|description|
42-
|---|---|---|
43-
|indexType|IndexType|It defines whether the pagination is zero or one based. default: 0|
44-
|pageSize|number|Page size of the pagination. default: 15|
41+
|value|type|default|description|
42+
|---|---|---|---|
43+
|indexType|IndexType|IndexType.ZERO_BASED|It defines whether the pagination is zero or one based.|
44+
|pageSize|number|15|Page size of the pagination.|
4545

46-
The hook returns the following object:
46+
#### The hook returns the following object:
4747

4848
|value|type|description|
4949
|---|---|---|
@@ -52,6 +52,8 @@ The hook returns the following object:
5252
|size|number|max elements in a single page|
5353
|actions|object|object with 3 functions: search, setPage, clear|
5454

55+
#### Example usage with NextJS
56+
5557
```tsx
5658
import { useSearchAndPagination } from '@aboutbits/react-pagination/dist/nextRouterPagination'
5759

0 commit comments

Comments
 (0)