@patternfly/react-core/dist/esm/components/Pagination/Navigation.d.ts

This library provides a set of common React components for use with the PatternFly reference implementation.

import * as React from 'react';
import { OnSetPage } from './Pagination';
import { PickOptional } from '../../helpers';
export interface NavigationProps extends React.HTMLProps<HTMLElement> {
    /** Additional classes for the pagination navigation container. */
    className?: string;
    /** Accessible label for the input displaying the current page. */
    currPageAriaLabel?: string;
    /** The number of first page where pagination starts. */
    firstPage?: number;
    /** Flag indicating if the pagination is compact. */
    isCompact?: boolean;
    /** Flag indicating if the pagination is disabled. */
    isDisabled?: boolean;
    /** Total number of items. */
    itemCount?: number;
    /** The number of the last page. */
    lastPage?: number;
    /** Label for the English word "of". */
    ofWord?: string;
    /** The number of the current page. */
    page: number;
    /** The title of a page displayed beside the page number. */
    pagesTitle?: string;
    /** The title of a page displayed beside the page number (the plural form). */
    pagesTitlePlural?: string;
    /** Accessible label for the pagination component. */
    paginationAriaLabel?: string;
    /** Number of items per page. */
    perPage?: number;
    /** Accessible label for the button which moves to the first page. */
    toFirstPageAriaLabel?: string;
    /** Accessible label for the button which moves to the last page. */
    toLastPageAriaLabel?: string;
    /** Accessible label for the button which moves to the next page. */
    toNextPageAriaLabel?: string;
    /** Accessible label for the button which moves to the previous page. */
    toPreviousPageAriaLabel?: string;
    /** Function called when user clicks to navigate to first page. */
    onFirstClick?: (event: React.SyntheticEvent<HTMLButtonElement>, page: number) => void;
    /** Function called when user clicks to navigate to last page. */
    onLastClick?: (event: React.SyntheticEvent<HTMLButtonElement>, page: number) => void;
    /** Function called when user clicks to navigate to next page. */
    onNextClick?: (event: React.SyntheticEvent<HTMLButtonElement>, page: number) => void;
    /** Function called when user clicks to navigate to previous page. */
    onPreviousClick?: (event: React.SyntheticEvent<HTMLButtonElement>, page: number) => void;
    /** Function called when user inputs page number. */
    onPageInput?: (event: React.KeyboardEvent<HTMLInputElement>, page: number) => void;
    /** Function called when page is changed. */
    onSetPage: OnSetPage;
}
export interface NavigationState {
    userInputPage?: number | string;
}
declare class Navigation extends React.Component<NavigationProps, NavigationState> {
    static displayName: string;
    constructor(props: NavigationProps);
    static defaultProps: PickOptional<NavigationProps>;
    private static parseInteger;
    private onChange;
    private onKeyDown;
    handleNewPage: (_evt: React.MouseEvent | React.KeyboardEvent | MouseEvent, newPage: number) => void;
    componentDidUpdate(lastState: NavigationProps): void;
    render(): React.JSX.Element;
}
export { Navigation };
//# sourceMappingURL=Navigation.d.ts.map