aboutsummaryrefslogtreecommitdiffstats
path: root/src/utils/hooks/use-pagination.tsx
blob: 706e65651d484cdf13454b5e4f91bfda7ff44bbc (plain)
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
pre { line-height: 125%; }
td.linenos .normal { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; }
span.linenos { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; }
td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
.highlight .hll { background-color: #ffffcc }
.highlight .c { color: #888888 } /* Comment */
.highlight .err { color: #a61717; background-color: #e3d2d2 } /* Error */
.highlight .k { color: #008800; font-weight: bold } /* Keyword */
.highlight .ch { color: #888888 } /* Comment.Hashbang */
.highlight .cm { color: #888888 } /* Comment.Multiline */
.highlight .cp { color: #cc0000; font-weight: bold } /* Comment.Preproc */
.highlight .cpf { color: #888888 } /* Comment.PreprocFile */
.highlight .c1 { color: #888888 } /* Comment.Single */
.highlight .cs { color: #cc0000; font-weight: bold; background-color: #fff0f0 } /* Comment.Special */
.highlight .gd { color: #000000; background-color: #ffdddd } /* Generic.Deleted */
.highlight .ge { font-style: italic } /* Generic.Emph */
.highlight .gr { color: #aa0000 } /* Generic.Error */
.highlight .gh { color: #333333 } /* Generic.Heading */
.highlight .gi { color: #000000; background-color: #ddffdd } /* Generic.Inserted */
.highlight .go { color: #888888 } /* Generic.Output */
.highlight .gp { color: #555555 } /* Generic.Prompt */
.highlight .gs { font-weight: bold } /* Generic.Strong */
.highlight .gu { color: #666666 } /* Generic.Subheading */
.highlight .gt { color: #aa0000 } /* Generic.Traceback */
.highlight .kc { color: #008800; font-weight: bold } /* Keyword.Constant */
.highlight .kd { color: #008800; font-weight: bold } /* Keyword.Declaration */
.highlight .kn { color: #008800; font-weight: bold } /* Keyword.Namespace */
.highlight .kp { color: #008800 } /* Keyword.Pseudo */
.highlight .kr { color: #008800; font-weight: bold } /* Keyword.Reserved */
.highlight .kt { color: #888888; font-weight: bold } /* Keyword.Type */
.highlight .m { color: #0000DD; font-weight: bold } /* Literal.Number */
.highlight .s { color: #dd2200; background-color: #fff0f0 } /* Literal.String */
.highlight .na { color: #336699 } /* Name.Attribute */
.highlight .nb { color: #003388 } /* Name.Builtin */
.highlight .nc { color: #bb0066; font-weight: bold } /* Name.Class */
.highlight .no { color: #003366; font-weight: bold } /* Name.Constant */
.highlight .nd { color: #555555 } /* Name.Decorator */
.highlight .ne { color: #bb0066; font-weight: bold } /* Name.Exception */
.highlight .nf { color: #0066bb; f
import useSWRInfinite, { SWRInfiniteKeyLoader } from 'swr/infinite';
import {
  type EdgesResponse,
  type GraphQLEdgesInput,
  type Search,
} from '../../types';

export type UsePaginationProps<T> = {
  /**
   * The initial data.
   */
  fallbackData: EdgesResponse<T>[];
  /**
   * A function to fetch more data.
   */
  fetcher: (props: GraphQLEdgesInput & Search) => Promise<EdgesResponse<T>>;
  /**
   * The number of results per page.
   */
  perPage: number;
  /**
   * An optional search string.
   */
  search?: string;
};

export type UsePaginationReturn<T> = {
  /**
   * The data from the API.
   */
  data?: EdgesResponse<T>[];
  /**
   * An error thrown by fetcher.
   */
  error: any;
  /**
   * Determine if there's more data to fetch.
   */
  hasNextPage?: boolean;
  /**
   * Determine if the initial data is loading.
   */
  isLoadingInitialData: boolean;
  /**
   * Determine if more data is currently loading.
   */
  isLoadingMore?: boolean;
  /**
   * Determine if the data is refreshing.
   */
  isRefreshing?: boolean;
  /**
   * Determine if there's a request or revalidation loading.
   */
  isValidating: boolean;
  /**
   * Set the number of pages that need to be fetched.
   */
  setSize: (
    size: number | ((_size: number) => number)
  ) => Promise<EdgesResponse<T>[] | undefined>;
};

/**
 * Handle data fetching with pagination.
 *
 * This hook is a wrapper of `useSWRInfinite` hook.
 *
 * @param {UsePaginationProps} props - The pagination configuration.
 * @returns {UsePaginationReturn} An object with pagination data and helpers.
 */
export const usePagination = <T extends object>({
  fallbackData,
  fetcher,
  perPage,
  search,
}: UsePaginationProps<T>): UsePaginationReturn<T> => {
  const getKey: SWRInfiniteKeyLoader = (
    pageIndex: number,
    previousData: EdgesResponse<T>
  ): (GraphQLEdgesInput & Search) | null => {
    // Reached the end.
    if (previousData && !previousData.edges.length) return null;

    // Fetch data using this parameters.
    return pageIndex === 0
      ? { first: perPage, search }
      : {
          first: perPage,
          after: previousData.pageInfo.endCursor,
          search,
        };
  };

  const { data, error, isValidating, size, setSize } = useSWRInfinite(
    getKey,
    fetcher,
    { fallbackData }
  );

  const isLoadingInitialData = !data && !error;
  const isLoadingMore =
    isLoadingInitialData ||
    (size > 0 && data && typeof data[size - 1] === 'undefined');
  const isRefreshing = isValidating && data && data.length === size;
  const hasNextPage =
    data && data.length > 0 && data[data.length - 1].pageInfo.hasNextPage;

  return {
    data,
    error,
    hasNextPage,
    isLoadingInitialData,
    isLoadingMore,
    isRefreshing,
    isValidating,
    setSize,
  };
};
span class="nx">json: `${CONFIG.url}${ROUTES.RSS}.json`, atom: `${CONFIG.url}${ROUTES.RSS}/atom`, }); expect(feed.options.generator).toBe('Feed & NextJS'); expect(feed.options.language).toBe(CONFIG.locales.defaultLocale); expect(feed.options.link).toBe(CONFIG.url); expect(feed.options.title).toBe(`${CONFIG.name} | ${CONFIG.baseline}`); expect(feed.items.length).toBeGreaterThan(0); }); /* eslint-enable max-statements */ });