-
Notifications
You must be signed in to change notification settings - Fork 0
/
usePaginationHelpers.ts
73 lines (63 loc) · 1.95 KB
/
usePaginationHelpers.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
import { useEffect, useRef } from 'react'
import { defaults } from 'lodash'
import {
resetPageIfFiltersChanged,
preventNonExistentPage,
getTotalPages,
} from '@interface-technologies/iti-react-core'
/**
* A hook that combines three things that need to be implemented when using pagination:
*
* - Resets page when filters change
* - Returns total number of pages
* - If the current page has no items and is not the first page, decrements the page
* (prevent non-existent pages). This situation occurs when someone deletes items
* while the user is viewing a paginated list.
*
* ```
* const totalPages = usePaginationHelpers(...)
* ```
*/
export function usePaginationHelpers<
TQueryParams extends { page: number; pageSize?: number }
>(options: {
queryParams: TQueryParams
items: unknown[]
totalCount: number
pageSizeWhenItemsRetrieved: number
onPageChange(page: number): void
firstPage?: 0 | 1
}): number {
const {
queryParams,
onPageChange,
firstPage,
items,
totalCount,
pageSizeWhenItemsRetrieved,
} = defaults(options, {
firstPage: 1,
})
const prevQueryParamsRef = useRef<TQueryParams>()
useEffect(() => {
if (prevQueryParamsRef.current) {
const newPage = resetPageIfFiltersChanged(
prevQueryParamsRef.current,
queryParams,
firstPage
).page
if (queryParams.page !== newPage) onPageChange(newPage)
}
prevQueryParamsRef.current = queryParams
}, [queryParams, firstPage, onPageChange])
const pageHasItems = items.length !== 0
useEffect(() => {
preventNonExistentPage({
page: queryParams.page,
pageHasItems,
onPageChange,
firstPage,
})
}, [queryParams.page, pageHasItems, onPageChange, firstPage])
return getTotalPages(totalCount, pageSizeWhenItemsRetrieved)
}