telebot-ts API Documentation - v1.0.0
    Preparing search index...

    Interface PaginationOptions<T>

    Options for configuring PaginationKeyboard.

    interface PaginationOptions<T> {
        callbackData?: (
            action: "prev" | "next" | "noop",
            page: number,
        ) => string;
        itemButton: (item: T, index: number) => InlineKeyboardButton;
        items: T[];
        navigation?: PaginationNavigationLabels;
        page?: number;
        pageSize?: number;
    }

    Type Parameters

    • T

      Type of the item data in the list.

    Index
    callbackData? itemButton items navigation? page? pageSize?
    callbackData?: (action: "prev" | "next" | "noop", page: number) => string

    Callback data generator for page navigation actions.

    itemButton: (item: T, index: number) => InlineKeyboardButton

    Function returning an InlineKeyboardButton for each item.

    items: T[]

    Total items list to paginate over.

    navigation?: PaginationNavigationLabels

    Custom labels and formatting for navigation buttons.

    Optionalpage

    page?: number

    Current active page index (1-indexed, default: 1).

    pageSize?: number

    Number of items displayed per page (default: 5).

    Settings
    Member Visibility

    On This Page
    Properties