react-pagination/src/engine/pagination.ts at b29d29ffac4d20cbdcaedfb4d1eadd15821a4c24 · aboutbits/react-pagination · GitHub

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
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
import { queryValueToIntOrUndefined } from '../utils'
import {
  Query,
  AbstractQuery,
  ParseQuery,
  useAbstractQuery,
  Router,
  AbstractQueryOptions,
} from './query'

export type PaginationQuery = {
  /**
   * The page index.
   *
   * @default 0
   */
  page: number
  /**
   * The size of one page.
   *
   * @default 15
   */
  size: number
}

const DEFAULT_PAGINATION: PaginationQuery = {
  page: 0,
  size: 15,
}

export type ChangeQueryOptions = {
  /**
   * Whether the page should be reset to its default value when the query is changed.
   *
   * @default true
   */
  resetPage: boolean
}

const DEFAULT_CHANGE_QUERY_OPTIONS: ChangeQueryOptions = { resetPage: true }

const parsePagination = (query: Query): Partial<PaginationQuery> => {
  return {
    page: queryValueToIntOrUndefined(query.page),
    size: queryValueToIntOrUndefined(query.size),
  }
}

export const useAbstractQueryAndPagination = <
  TQuery extends AbstractQuery,
  TDefaultQuery extends Partial<TQuery>,
>(
  router: Router,
  parseQuery: ParseQuery<TQuery>,
  defaultQuery: TDefaultQuery,
  defaultPagination?: Partial<PaginationQuery>,
  options?: Partial<AbstractQueryOptions>,
) => {
  const mergedDefaultPagination = {
    ...DEFAULT_PAGINATION,
    ...defaultPagination,
  }
  const mergedDefaultQueryAndPagination = {
    ...defaultQuery,
    ...mergedDefaultPagination,
  }

  const { query, setQuery } = useAbstractQuery(
    router,
    parseQuery,
    mergedDefaultQueryAndPagination,
    options,
  )

  const {
    query: pagination,
    setQuery: setPagination,
    resetQuery: resetPagination,
  } = useAbstractQuery(
    router,
    parsePagination,
    mergedDefaultPagination,
    options,
  )

  return {
    query,
    setQuery: (
      query: Partial<TQuery>,
      options?: Partial<ChangeQueryOptions>,
    ) => {
      const mergedOptions = { ...DEFAULT_CHANGE_QUERY_OPTIONS, ...options }
      setQuery({
        ...query,
        page: mergedOptions.resetPage
          ? mergedDefaultPagination.page
          : undefined,
      })
    },
    resetQuery: (options?: Partial<ChangeQueryOptions>) => {
      const mergedOptions = { ...DEFAULT_CHANGE_QUERY_OPTIONS, ...options }
      setQuery({
        ...defaultQuery,
        page: mergedOptions.resetPage
          ? mergedDefaultPagination.page
          : undefined,
      })
    },
    page: pagination.page,
    size: pagination.size,
    setPage: (page: PaginationQuery['page']) => {
      setPagination({ page })
    },
    setSize: (size: PaginationQuery['size']) => {
      setPagination({ size })
    },
    setPagination,
    resetPagination,
    resetQueryAndPagination: () => {
      setQuery(mergedDefaultQueryAndPagination)
    },
  }
}