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

    Interface RenderPaginationOptions

    Options accepted by renderPagination.

    interface RenderPaginationOptions {
        page: number;
        siblingCount?: number;
        showBoundaryControls?: boolean;
        pageCount: number;
        characters?: PaginationCharacters;
        separator?: string;
        width: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    page: number

    Current 1-based page. Values outside the range are clamped.

    siblingCount?: number

    Number of page links shown around the current page.

    1

    showBoundaryControls?: boolean

    Whether first and last controls should be rendered.

    false

    pageCount: number

    Total number of pages.

    Character and label tokens used by the renderer.

    separator?: string

    Text inserted between pagination items.

    ' '

    width: number

    Maximum terminal-cell width of the rendered line.