Interface Options

The options to customize the pagination.

Hierarchy

Properties

attachments: (BufferResolvable | Stream | JSONEncodable<APIAttachment> | Attachment | AttachmentBuilder | AttachmentPayload)[]

The attachments to show with the paginated messages.

Default Value

[]

buttonStyle: PButtonStyle

The style of the paginator buttons.

Default Value

"SECONDARY"

contents: string[]

Contents if changing contents per page.

Default Value

[]

ephemeral: boolean

Whether the reply should be ephemeral.

Default Value

false

firstEmoji: ComponentEmojiResolvable

The emoji to use for the first button.

Default Value

"⏮"

firstLabel: string

The label for the first page button.

Default Value

""

idle: number

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

Default Value

5 minutes

lastEmoji: ComponentEmojiResolvable

The emoji to use for the last button.

Default Value

"⏭"

lastLabel: string

The label for the last page button.

Default Value

""

limit: number

The number of entries to show per page.

Default Value

5

loop: boolean

loop through the pages.

Default Value

false

nextEmoji: ComponentEmojiResolvable

The emoji to use for the next button.

Default Value

"▶️"

nextLabel: string

The label for the next page button.

Default Value

""

postDescription: string

The description to show after the paginated descriptions.

Default Value

""

prevDescription: string

The description to show before the paginated descriptions.

Default Value

""

prevEmoji: ComponentEmojiResolvable

The emoji to use for the previous button.

Default Value

"◀️"

prevLabel: string

The label for the previous page button.

Default Value

""

Generated using TypeDoc