blessed-components - v1.20.0
    Preparing search index...

    Interface PaginationData

    Stateful data accepted by the Blessed pagination adapter.

    interface PaginationData {
        characters?: PaginationCharacters;
        defaultPage?: number;
        onPageChange?: (page: number) => void;
        page?: number;
        pageCount: number;
        separator?: string;
        siblingCount?: number;
        showBoundaryControls?: boolean;
    }
    Index

    Properties

    characters? defaultPage? onPageChange? page? pageCount separator? siblingCount? showBoundaryControls?

    Properties

    characters?: PaginationCharacters

    Character and label tokens used by the pure renderer.

    defaultPage?: number

    Initial page for uncontrolled usage. Ignored when page is supplied.

    onPageChange?: (page: number) => void

    Called after a page change or controlled page request.

    Optionalpage

    page?: number

    Controlled 1-based current page.

    pageCount: number

    Total number of pages.

    separator?: string

    Text inserted between rendered pagination items.

    siblingCount?: number

    Number of page links shown around the current page.

    showBoundaryControls?: boolean

    Whether first and last controls should be rendered.

    Settings

    Member Visibility

    On This Page

    Properties