@vtex/admin-ui
Version:
> VTEX admin component library
36 lines (35 loc) • 1.08 kB
TypeScript
import type { ComponentPropsWithRef } from 'react';
import type { UsePaginationReturn } from './hooks/usePaginationState';
export declare const Pagination: import("@vtex/admin-ui-react").AdminUIJsxElement<"div", PaginationOptions, {}>;
export interface PaginationOptions {
/**
* String displayed in between the end of the range and the total amount of items
* @default 'of'
*/
preposition?: string;
/**
* String displayed in the end of the component
* @default 'results'
*/
subject?: string;
/**
* Label used in previous button tooltip
* @default 'Back'
*/
prevLabel?: string;
/**
* Label used in next button tooltip
* @default 'Next'
*/
nextLabel?: string;
/**
* Whether the table is loading or not
* @default false
*/
loading?: boolean;
/**
* Object used to show and control pagination component
*/
state: UsePaginationReturn;
}
export declare type PaginationProps = ComponentPropsWithRef<typeof Pagination>;