@shopify/polaris
Version:
Shopify’s admin product component library
37 lines (36 loc) • 1.46 kB
TypeScript
import React from 'react';
import { Key } from '../../types';
interface AccessibilityLabels {
previous: string;
next: string;
}
export interface PaginationProps {
/** Keyboard shortcuts for the next button */
nextKeys?: Key[];
/** Keyboard shortcuts for the previous button */
previousKeys?: Key[];
/** Tooltip for the next button */
nextTooltip?: string;
/** Tooltip for the previous button */
previousTooltip?: string;
/** The URL of the next page */
nextURL?: string;
/** The URL of the previous page */
previousURL?: string;
/** Whether there is a next page to show */
hasNext?: boolean;
/** Whether there is a previous page to show */
hasPrevious?: boolean;
/** Accessible label for the pagination */
accessibilityLabel?: string;
/** Accessible labels for the buttons and UnstyledLinks */
accessibilityLabels?: AccessibilityLabels;
/** Callback when next button is clicked */
onNext?(): void;
/** Callback when previous button is clicked */
onPrevious?(): void;
/** Text to provide more context in between the arrow buttons */
label?: React.ReactNode;
}
export declare function Pagination({ hasNext, hasPrevious, nextURL, previousURL, onNext, onPrevious, nextTooltip, previousTooltip, nextKeys, previousKeys, accessibilityLabel, accessibilityLabels, label, }: PaginationProps): JSX.Element;
export {};