@primer/react/dist/DataTable/Pagination.d.ts

An implementation of GitHub's Primer Design System using React

import { ResponsiveValue } from "../hooks/useResponsiveValue.js";
import React from "react";

//#region src/DataTable/Pagination.d.ts
type PaginationProps = Omit<React.ComponentPropsWithoutRef<'nav'>, 'onChange'> & {
  /**
   * Provide a label for the navigation landmark rendered by this component
   */
  'aria-label': string;
  /**
   * Provide an optional index to specify the default selected page
   */
  defaultPageIndex?: number;
  /**
   * Optionally provide an `id` that is placed on the navigation landmark
   * rendered by this component
   */
  id?: string;
  /**
   * Optionally provide a handler that is called whenever the pagination state
   * is updated
   */
  onChange?: (state: PaginationState) => void;
  /**
   * Optionally specify the number of items within a page
   */
  pageSize?: number;
  /**
   * Whether to show the page numbers
   */
  showPages?: boolean | ResponsiveValue<boolean>;
  /**
   * Specify the total number of items within the collection
   */
  totalCount: number;
};
declare function Pagination({
  'aria-label': label,
  defaultPageIndex,
  id,
  onChange,
  pageSize,
  showPages,
  totalCount
}: PaginationProps): React.JSX.Element;
type PaginationState = {
  /**
   * The index of currently selected page
   */
  pageIndex: number;
};
//#endregion
export { Pagination, PaginationProps };