@devopness/ui-react
Version:
Devopness Design System React Components - Painless essential DevOps to everyone
38 lines (37 loc) • 1.63 kB
TypeScript
import { MouseEventHandler } from 'react';
type PaginationProps = {
/** Disable all pagination actions */
disableAllActions?: boolean;
/** Disable only previous/back pagination actions */
disablePreviousActions?: boolean;
/** Disable only next/forward pagination actions */
disableNextActions?: boolean;
/** Hide first page and last page buttons */
hideFirstAndLastButton?: boolean;
/** Handler for navigating to first page */
firstPaginateAction: MouseEventHandler<HTMLButtonElement>;
/** Handler for navigating to previous page */
previousPaginateAction: MouseEventHandler<HTMLButtonElement>;
/** Handler for navigating to next page */
nextPaginateAction: MouseEventHandler<HTMLButtonElement>;
/** Handler for navigating to last page */
lastPaginateAction: MouseEventHandler<HTMLButtonElement>;
};
/**
* Pagination controls for navigating through paginated content
*
* @example
* ```jsx
* <Pagination
* firstPaginateAction={() => goToPage(1)}
* previousPaginateAction={() => goToPage(currentPage - 1)}
* nextPaginateAction={() => goToPage(currentPage + 1)}
* lastPaginateAction={() => goToPage(totalPages)}
* disableNextActions={currentPage === totalPages}
* disablePreviousActions={currentPage === 1}
* />
* ```
*/
declare const Pagination: ({ disableAllActions, disablePreviousActions, disableNextActions, hideFirstAndLastButton, firstPaginateAction, previousPaginateAction, nextPaginateAction, lastPaginateAction, }: PaginationProps) => import("react/jsx-runtime").JSX.Element;
export type { PaginationProps };
export { Pagination };