add additional list pagination helpers and components

This commit is contained in:
jeffvli
2025-09-29 00:33:32 -07:00
parent 90e7541bc1
commit 3efa54b68a
7 changed files with 188 additions and 35 deletions
@@ -4,15 +4,17 @@ import { queryKeys } from '/@/renderer/api/query-keys';
import { getServerById } from '/@/renderer/store';
export interface PaginatedListProps<TQuery> {
initialPage?: number;
itemsPerPage?: number;
query: Omit<TQuery, 'limit' | 'startIndex'>;
serverId: string;
}
interface UseItemListPaginatedLoaderProps {
currentPage: number;
itemsPerPage: number;
listCountQuery: UseSuspenseQueryOptions<number, Error, number, readonly unknown[]>;
listQueryFn: (args: { apiClientProps: any; query: any }) => Promise<{ items: unknown[] }>;
pageIndex: number;
query: Record<string, any>;
serverId: string;
}
@@ -22,28 +24,30 @@ function getInitialData(itemCount: number) {
}
export const useItemListPaginatedLoader = ({
currentPage,
itemsPerPage = 100,
listCountQuery,
listQueryFn,
pageIndex,
query = {},
serverId,
}: UseItemListPaginatedLoaderProps) => {
const { data: totalItemCount } = useSuspenseQuery<number, any, number, any>(listCountQuery);
const pageCount = Math.ceil(totalItemCount / itemsPerPage);
const fetchRange = getFetchRange(currentPage, itemsPerPage);
const startIndex = fetchRange.startIndex;
const queryParams = {
limit: itemsPerPage,
startIndex: startIndex,
...query,
};
const { data } = useQuery({
gcTime: 1000 * 15,
initialData: getInitialData(totalItemCount),
placeholderData: getInitialData(itemsPerPage),
queryFn: async ({ signal }) => {
const fetchRange = getFetchRange(pageIndex, itemsPerPage);
const startIndex = fetchRange.startIndex;
const queryParams = {
limit: itemsPerPage,
startIndex: startIndex,
...query,
};
const result = await listQueryFn({
apiClientProps: { server: getServerById(serverId), signal },
query: queryParams,
@@ -51,11 +55,11 @@ export const useItemListPaginatedLoader = ({
return result.items;
},
queryKey: queryKeys.albums.list(serverId, query),
queryKey: queryKeys.albums.list(serverId, queryParams),
staleTime: 1000 * 15,
});
return { data };
return { data, pageCount, totalItemCount };
};
const getFetchRange = (pageIndex: number, itemsPerPage: number) => {
@@ -0,0 +1,9 @@
.container {
display: flex;
flex-direction: column;
gap: var(--theme-spacing-md);
width: 100%;
height: 100%;
min-height: 0;
padding: var(--theme-spacing-md);
}
@@ -0,0 +1,36 @@
import { Fragment, ReactNode } from 'react';
import styles from './item-list-pagination.module.css';
import { Pagination } from '/@/shared/components/pagination/pagination';
interface ItemListWithPaginationProps {
children: ReactNode;
currentPage: number;
itemsPerPage: number;
onChange: (e: number) => void;
pageCount: number;
totalItemCount: number;
}
export const ItemListWithPagination = ({
children,
currentPage,
itemsPerPage,
onChange,
pageCount,
totalItemCount,
}: ItemListWithPaginationProps) => {
return (
<div className={styles.container}>
<Fragment key={currentPage}>{children}</Fragment>
<Pagination
itemsPerPage={itemsPerPage}
onChange={onChange}
total={pageCount}
totalItemCount={totalItemCount}
value={currentPage}
/>
</div>
);
};
@@ -0,0 +1,23 @@
import { useSearchParams } from 'react-router-dom';
interface UseItemListPaginationProps {
initialPage?: number;
}
export const useItemListPagination = ({ initialPage }: UseItemListPaginationProps) => {
const [searchParams, setSearchParams] = useSearchParams();
const currentPage = initialPage || Number(searchParams.get('currentPage')) || 0;
const onChange = (index: number) => {
setSearchParams(
(params) => {
params.set('currentPage', String(index));
return params;
},
{ replace: true },
);
};
return { currentPage, onChange };
};