11220099683

Committed 03 Oct 2024 01:50PM UTC coverage: 97.53% (+0.1%) from 97.43%

Build # 11220099683

Build Type

push

github

Committed by

web-flow

Commit Message

Merge pull request #509 from IQSS/feat/484-collection-page-results-of-all-types

Feat/484 Collection page results of all types

Run Details

1415 of 1475 branches covered (95.93%)

Branch coverage included in aggregate %.

285 of 286 new or added lines in 33 files covered. (99.65%)

4 existing lines in 1 file now uncovered.

3679 of 3748 relevant lines covered (98.16%)

8698.57 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

71.43

/src/sections/shared/pagination/PaginationControls.tsx

import { Col, Pagination, Row } from '@iqss/dataverse-design-system'
import { PageNumbersButtonsWithEllipsis } from './PageNumbersButtonsWithEllipsis'
import { PageSizeSelector } from './PageSizeSelector'
import styles from './Pagination.module.scss'
import { PaginationInfo } from '../../../shared/pagination/domain/models/PaginationInfo'
import { useEffect, useState } from 'react'
import { FilePaginationInfo } from '../../../files/domain/models/FilePaginationInfo'
import { DatasetPaginationInfo } from '../../../dataset/domain/models/DatasetPaginationInfo'
import { useSearchParams } from 'react-router-dom'

interface PaginationProps {
  onPaginationInfoChange: (
    paginationInfo: PaginationInfo<DatasetPaginationInfo | FilePaginationInfo>
  ) => void
  initialPaginationInfo: PaginationInfo<DatasetPaginationInfo | FilePaginationInfo>
  showPageSizeSelector?: boolean
  updateQueryParam?: boolean
}
const MINIMUM_NUMBER_OF_PAGES_TO_DISPLAY_PAGINATION = 2
export function PaginationControls({
  onPaginationInfoChange,
  initialPaginationInfo,
  showPageSizeSelector = true,
  updateQueryParam = false
}: PaginationProps) {
  const [searchParams, setSearchParams] = useSearchParams()
  const [paginationInfo, setPaginationInfo] = useState<DatasetPaginationInfo | FilePaginationInfo>(
    initialPaginationInfo
  )
  const goToPage = (newPage: number) => {
    setPaginationInfo(paginationInfo.goToPage(newPage))
  }
  const goToPreviousPage = () => {
    setPaginationInfo(paginationInfo.goToPreviousPage())
  }
  const goToNextPage = () => {
    setPaginationInfo(paginationInfo.goToNextPage())
  }
  const setPageSize = (newPageSize: number) => {
    setPaginationInfo(paginationInfo.withPageSize(newPageSize))
  }

  useEffect(() => {
    onPaginationInfoChange(paginationInfo)
  }, [paginationInfo.pageSize])

  useEffect(() => {
    onPaginationInfoChange(paginationInfo)
    if (updateQueryParam) {
      if (searchParams.get('page') !== paginationInfo.page.toString()) {
        searchParams.set('page', paginationInfo.page.toString())
        setSearchParams(searchParams)
      }
    }
  }, [paginationInfo.page])

  useEffect(() => {
    setPaginationInfo(paginationInfo.withTotal(initialPaginationInfo.totalItems))
  }, [initialPaginationInfo.totalItems])

  useEffect(() => {
    if (updateQueryParam) {
      if (searchParams.get('page') !== paginationInfo.page.toString()) {
        const page = searchParams.get('page') ? parseInt(searchParams.get('page') as string) : 1
        searchParams.set('page', page.toString())
        setSearchParams(searchParams, { replace: true })
        goToPage(page)
      }
    }
  }, [searchParams])

  if (paginationInfo.totalPages < MINIMUM_NUMBER_OF_PAGES_TO_DISPLAY_PAGINATION) {
    return <></>
  }
  return (
    <Row className={styles.row}>
      <Col md="auto">
        <div className={styles.container}>
          <Pagination>
            <Pagination.First
              onClick={() => goToPage(1)}
              disabled={!paginationInfo.hasPreviousPage}
            />
            <Pagination.Prev
              onClick={() => goToPreviousPage()}
              disabled={!paginationInfo.hasPreviousPage}
            />
            <PageNumbersButtonsWithEllipsis
              selectedPageIndex={paginationInfo.page - 1}
              pageCount={paginationInfo.totalPages}
              goToPage={goToPage}
            />
            <Pagination.Next
              onClick={() => goToNextPage()}
              disabled={!paginationInfo.hasNextPage}
            />
            <Pagination.Last
              onClick={() => goToPage(paginationInfo.totalPages)}
              disabled={!paginationInfo.hasNextPage}
            />
          </Pagination>
          {showPageSizeSelector && (
            <PageSizeSelector
              itemName={paginationInfo.itemName}
              pageSize={paginationInfo.pageSize}
              setPageSize={setPageSize}
            />
          )}
        </div>
      </Col>
    </Row>
  )
}

1	import { Col, Pagination, Row } from '@iqss/dataverse-design-system'
2	import { PageNumbersButtonsWithEllipsis } from './PageNumbersButtonsWithEllipsis'
3	import { PageSizeSelector } from './PageSizeSelector'
4	import styles from './Pagination.module.scss'
5	import { PaginationInfo } from '../../../shared/pagination/domain/models/PaginationInfo'
6	import { useEffect, useState } from 'react'
7	import { FilePaginationInfo } from '../../../files/domain/models/FilePaginationInfo'
8	import { DatasetPaginationInfo } from '../../../dataset/domain/models/DatasetPaginationInfo'
9	import { useSearchParams } from 'react-router-dom'
10
11	interface PaginationProps {
12	onPaginationInfoChange: (
13	paginationInfo: PaginationInfo<DatasetPaginationInfo \| FilePaginationInfo>
14	) => void
15	initialPaginationInfo: PaginationInfo<DatasetPaginationInfo \| FilePaginationInfo>
16	showPageSizeSelector?: boolean
17	updateQueryParam?: boolean
18	}
19	const MINIMUM_NUMBER_OF_PAGES_TO_DISPLAY_PAGINATION = 2	46✔
20	export function PaginationControls({	46✔
21	onPaginationInfoChange,
22	initialPaginationInfo,
23	showPageSizeSelector = true,	2,142✔
24	updateQueryParam = false	2,146✔
25	}: PaginationProps) {	2,146✔
26	const [searchParams, setSearchParams] = useSearchParams()	2,146✔
27	const [paginationInfo, setPaginationInfo] = useState<DatasetPaginationInfo \| FilePaginationInfo>(	2,146✔
28	initialPaginationInfo
29	)
30	const goToPage = (newPage: number) => {	2,146✔
31	setPaginationInfo(paginationInfo.goToPage(newPage))	115✔
32	}
33	const goToPreviousPage = () => {	2,146✔
34	setPaginationInfo(paginationInfo.goToPreviousPage())	24✔
35	}
36	const goToNextPage = () => {	2,146✔
37	setPaginationInfo(paginationInfo.goToNextPage())	34✔
38	}
39	const setPageSize = (newPageSize: number) => {	2,146✔
40	setPaginationInfo(paginationInfo.withPageSize(newPageSize))	115✔
41	}
42
43	useEffect(() => {	2,146✔
44	onPaginationInfoChange(paginationInfo)	517✔
45	}, [paginationInfo.pageSize])
46
47	useEffect(() => {	2,146✔
48	onPaginationInfoChange(paginationInfo)	617✔
49	if (updateQueryParam) {	617!
UNCOV 50	if (searchParams.get('page') !== paginationInfo.page.toString()) {	×
UNCOV 51	searchParams.set('page', paginationInfo.page.toString())	×
UNCOV 52	setSearchParams(searchParams)	×
53	}
54	}
55	}, [paginationInfo.page])
56
57	useEffect(() => {	2,146✔
58	setPaginationInfo(paginationInfo.withTotal(initialPaginationInfo.totalItems))	738✔
59	}, [initialPaginationInfo.totalItems])
60
61	useEffect(() => {	2,146✔
62	if (updateQueryParam) {	402!
UNCOV 63	if (searchParams.get('page') !== paginationInfo.page.toString()) {	×
64	const page = searchParams.get('page') ? parseInt(searchParams.get('page') as string) : 1	×
65	searchParams.set('page', page.toString())	×
66	setSearchParams(searchParams, { replace: true })	×
67	goToPage(page)	×
68	}
69	}
70	}, [searchParams])
71
72	if (paginationInfo.totalPages < MINIMUM_NUMBER_OF_PAGES_TO_DISPLAY_PAGINATION) {	2,146✔
73	return <></>	1,150✔
74	}
75	return (	996✔
76	<Row className={styles.row}>
77	<Col md="auto">
78	<div className={styles.container}>
79	<Pagination>
80	<Pagination.First
81	onClick={() => goToPage(1)}	8✔
82	disabled={!paginationInfo.hasPreviousPage}
83	/>
84	<Pagination.Prev
85	onClick={() => goToPreviousPage()}	24✔
86	disabled={!paginationInfo.hasPreviousPage}
87	/>
88	<PageNumbersButtonsWithEllipsis
89	selectedPageIndex={paginationInfo.page - 1}
90	pageCount={paginationInfo.totalPages}
91	goToPage={goToPage}
92	/>
93	<Pagination.Next
94	onClick={() => goToNextPage()}	34✔
95	disabled={!paginationInfo.hasNextPage}
96	/>
97	<Pagination.Last
98	onClick={() => goToPage(paginationInfo.totalPages)}	17✔
99	disabled={!paginationInfo.hasNextPage}
100	/>
101	</Pagination>
102	{showPageSizeSelector && (	1,992✔
103	<PageSizeSelector
104	itemName={paginationInfo.itemName}
105	pageSize={paginationInfo.pageSize}
106	setPageSize={setPageSize}
107	/>
108	)}
109	</div>
110	</Col>
111	</Row>
112	)
113	}	46✔

IQSS / dataverse-frontend / 11220099683

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous