@massds/mayflower-react
Version:
React versions of Mayflower design system UI components
43 lines (42 loc) • 1.58 kB
TypeScript
export interface PaginationProps {
/** Custom class to add to the root element. */
className?: string;
/** next.disabled: Defines whether the next button is available or not to users.
next.text: Defines the text shown for the next button. */
next?: {
disabled?: boolean;
text: string;
href?: string;
hide?: boolean;
onClick?(...args: unknown[]): unknown;
};
/** prev.disabled: Defines whether the prev button is available or not to users.
prev.text: Defines the text shown for the previous button. */
prev?: {
disabled?: boolean;
text: string;
href?: string;
hide?: boolean;
onClick?(...args: unknown[]): unknown;
};
/** prev.text: Defines the text shown for the previous button for screen readers.
prev.description: Define the description shown before the first pagination link for screen readers
prev.fragement: Defines id of the element to go back to */
backToTop?: {
text: string;
description: string;
fragment?: string;
};
/** Pages is an array that defines what page numbers users are able to paginate through.
pages.active: Defines whether the page number is active or not.
pages.text: Defines the text shown for page number. */
pages?: {
active?: boolean;
text: string;
href?: string;
hide?: boolean;
onClick?(...args: unknown[]): unknown;
}[];
}
declare const Pagination: (props: PaginationProps) => any;
export default Pagination;