Pagination
    Preparing search index...

    Interface Options

    The options to customize the pagination.

    interface Options {
        attachments: PAttachments;
        buttonStyle: PButtonStyle;
        contents: string[];
        ephemeral: boolean;
        firstEmoji: ComponentEmojiResolvable;
        firstLabel: string;
        idle: number;
        lastEmoji: ComponentEmojiResolvable;
        lastLabel: string;
        limit: number;
        loop: boolean;
        nextEmoji: ComponentEmojiResolvable;
        nextLabel: string;
        postDescription: string;
        prevDescription: string;
        prevEmoji: ComponentEmojiResolvable;
        prevLabel: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    attachments buttonStyle contents ephemeral firstEmoji firstLabel idle lastEmoji lastLabel limit loop nextEmoji nextLabel postDescription prevDescription prevEmoji prevLabel

    Properties

    attachments: PAttachments

    The attachments to show with the paginated messages.

    []
    buttonStyle: PButtonStyle

    The style of the paginator buttons.

    "SECONDARY"
    contents: string[]

    Contents if changing contents per page.

    []
    ephemeral: boolean

    Whether the reply should be ephemeral. This will be converted to MessageFlags.Ephemeral internally.

    false
    firstEmoji: ComponentEmojiResolvable

    The emoji to use for the first button.

    "⏮"
    firstLabel: string

    The label for the first page button.

    ""
    idle: number

    The number of seconds before the paginator will close after inactivity.

    5 minutes
    lastEmoji: ComponentEmojiResolvable

    The emoji to use for the last button.

    "⏭"
    lastLabel: string

    The label for the last page button.

    ""
    limit: number

    The number of entries to show per page.

    5
    loop: boolean

    loop through the pages.

    false
    nextEmoji: ComponentEmojiResolvable

    The emoji to use for the next button.

    "▶️"
    nextLabel: string

    The label for the next page button.

    ""
    postDescription: string

    The description to show after the paginated descriptions.

    ""
    prevDescription: string

    The description to show before the paginated descriptions.

    ""
    prevEmoji: ComponentEmojiResolvable

    The emoji to use for the previous button.

    "◀️"
    prevLabel: string

    The label for the previous page button.

    ""

    Settings

    Member Visibility

    On This Page

    Properties