g3-toolkit API Reference
    Preparing search index...

    Interface PaginationControlProps

    interface PaginationControlProps {
        ariaLabel?: string;
        className?: string;
        hideSummary?: boolean;
        noun?: string;
        onPageChange: (page: number) => void;
        onPageSizeChange?: (pageSize: number) => void;
        page: number;
        pageSize: number;
        pageSizeOptions?: readonly number[];
        style?: CSSProperties;
        testId?: string;
        total: number;
        totalExact?: boolean;
    }
    Index

    Properties

    ariaLabel? className? hideSummary? noun? onPageChange onPageSizeChange? page pageSize pageSizeOptions? style? testId? total totalExact?

    Properties

    ariaLabel?: string

    Accessible name of the control. Default " pagination".

    className?: string
    hideSummary?: boolean

    Hide the "rows 1 to 200 of 350" summary.

    noun?: string

    Noun for the summary and the aria-labels ("rows", "columns"). Default "items".

    onPageChange: (page: number) => void

    Receives the next zero-based page index.

    onPageSizeChange?: (pageSize: number) => void

    page

    page: number

    Zero-based page index.

    pageSize: number

    Items per page; the page count is derived from it and total.

    pageSizeOptions?: readonly number[]

    Offer a page-size select with these options. Needs onPageSizeChange; without it no select renders.

    style?: CSSProperties
    testId?: string
    total: number

    Total items across all pages.

    totalExact?: boolean

    False when total is an estimate; the summary then says "about".

    Settings

    Member Visibility

    On This Page

    Properties