Class PaginationEmbed`Abstract`

The PaginationEmbed class.

Hierarchy

EmbedBuilder
- PaginationEmbed
  - Pagination

Index

Constructors

constructor

Constructors

constructor

new PaginationEmbed(options?): PaginationEmbed

Example

const pagination = new PaginationEmbed({
 firstEmoji: "⏮",
 prevEmoji: "◀️",
 nextEmoji: "▶️",
 lastEmoji: "⏭",
 limit: 5,
 idle: 5 * 60 * 1000,
 ephemeral: false,
 prevDescription: "",
 postDescription: "",
 attachments: [],
 buttonStyle: ButtonStyle.Secondary,
 loop: false,
});

Parameters

options: Partial<Options> = {}

The pagination options

Returns PaginationEmbed

Properties

actionRows

actionRows: ActionRowBuilder<MessageActionRowComponentBuilder>[]

The action rows of the final message.

attachments

The attachments to show with the paginated messages.

Default Value

[]

`Readonly` buttonInfo

buttonInfo: ButtonsOptions

Pagination button infos.

Default Value

defaultOptions.buttonInfo

buttons

buttons: Record<string, PButtonBuilder>

The pagination buttons.

`Private` `Optional` changedButtons

changedButtons?: boolean

Changed default buttons

`Private` contents

contents: null | string | (null | string)[]

Contents if changing contents per page.

Default Value

[]

currentPage

currentPage: number

The current page number.

`Private` customFooter

customFooter: boolean

Whether the footer is a custom footer or not.

`Readonly` data

data: APIEmbed

The API data associated with this embed.

descriptions

descriptions: string[]

The descriptions to paginate through.

embeds

embeds: (APIEmbed | JSONEncodable<APIEmbed>)[]

The embeds if paginating through embeds.

Default Value

[]

ephemeral

ephemeral: boolean

Whether the reply should be ephemeral or not.

Default Value

false

`Private` `Readonly` extraRows

extraRows: {
position: ExtraRowPosition;
rows: ActionRowBuilder<MessageActionRowComponentBuilder>[];
}[]

The extra action rows to add, if any.

Default Value

[]

fieldPaginate

fieldPaginate: boolean

Whether if paginating through embed's fields.

Default Value

false

idle

idle: number

The idle time before closing.

Default Value

5 * 60 * 1_000

images

images: string[]

The images to paginate through.

limit

limit: number

The limit of entries per page.

Default Value

loop

loop: boolean

Whether to loop through the pages or not.

Default Value

false

`Private` `Readonly` mainActionRow

mainActionRow: ActionRowBuilder<MessageActionRowComponentBuilder>

The main action row.

`Private` `Readonly` payload

payload: Payload

The payload of the final message.

postDescription

postDescription: string

The description to show after the paginated descriptions.

Default Value

prevDescription

prevDescription: string

The description to show before the paginated descriptions.

Default Value

`Private` rawFields

rawFields: APIEmbedField[]

All the fields if paginating through fields.

`Private` rawFooter

rawFooter: string

The raw footer text.

totalEntry

totalEntry: number

The total number of entries.

totalPages

totalPages: number

The total number of pages.

Methods

`Private` _readyActionRows

_readyActionRows(): PaginationEmbed
Prepare the message's action rows for pagination.

Returns PaginationEmbed
- Defined in src/lib/pagination/PaginationEmbed.ts:1005

`Private` _readyButton

_readyButton(button, label, emoji, style): PaginationEmbed
Parameters
- button: ButtonBuilder
- label: undefined | string
- emoji: undefined | ComponentEmojiResolvable
- style: PButtonStyle
Returns PaginationEmbed
- Defined in src/lib/pagination/PaginationEmbed.ts:993

`Private` _readyPayloads

_readyPayloads(): Payload
Prepare the message's payload.

Returns Payload
- Defined in src/lib/pagination/PaginationEmbed.ts:1042

addActionRows

addActionRows(actionRows, position?): PaginationEmbed
Adds a custom action row below or above the pagination button action row.

Example
```
const pagination = new Pagination(interaction)
 .addActionRows([new ActionRowBuilder()], ExtraRowPosition.Below);
```
Parameters
- actionRows: ActionRowBuilder<MessageActionRowComponentBuilder>[]
  
  The action rows to add
- position: ExtraRowPosition = ExtraRowPosition.Below
  
  The position where the action rows to be added
Returns PaginationEmbed
- Defined in src/lib/pagination/PaginationEmbed.ts:738

addAttachment

addAttachment(attachment): PaginationEmbed
Adds an attachment to the existing attachments.

Example
```
const pagination = new Pagination(interaction)
 .setAttachments([new AttachmentBuilder()])
 .addAttachment(new AttachmentBuilder());
```
Parameters
- attachment: BufferResolvable | Stream | JSONEncodable<APIAttachment> | Attachment | AttachmentBuilder | AttachmentPayload
  
  The attachment to add
Returns PaginationEmbed
- Defined in src/lib/pagination/PaginationEmbed.ts:774

addAttachments

addAttachments(attachments): PaginationEmbed
Adds multiple attachments to the existing attachments.

Example
```
const pagination = new Pagination(interaction)
 .setAttachments([new AttachmentBuilder()])
 .addAttachments([new AttachmentBuilder(), new AttachmentBuilder()]);
```
Parameters
- attachments: (BufferResolvable | Stream | JSONEncodable<APIAttachment> | Attachment | AttachmentBuilder | AttachmentPayload)[]
  
  The attachments to add
Returns PaginationEmbed
- Defined in src/lib/pagination/PaginationEmbed.ts:791

addDescriptions

addDescriptions(...descriptions): PaginationEmbed

Adds multiple pagination descriptions.

Example

const pagination = new Pagination(interaction)
 .setDescriptions(["1st description", "2nd description", "3rd description"])
 .addDescriptions(["4st description", "5nd description", "6rd description"]);

Parameters

Rest ...descriptions: RestOrArray<string>

The descriptions to set

Returns PaginationEmbed

addEmbeds

addEmbeds(embeds, template?): PaginationEmbed
Adds multiple pagination embeds.

Example
```
const pagination = new Pagination(interaction)
 .setEmbeds([new EmbedBuilder(), new EmbedBuilder(), new EmbedBuilder()])
 .addEmbeds([new EmbedBuilder(), new EmbedBuilder(), new EmbedBuilder()]);
```
Parameters
- embeds: (APIEmbed | JSONEncodable<APIEmbed>)[]
  
  An array of EmbedBuilder or APIEmbed
- Optional template: ((embed) => JSONEncodable<APIEmbed>)
  
  A template function that will be called for each embed.
  - - (embed): JSONEncodable<APIEmbed>
    - Parameters
      
      embed: EmbedBuilder
      
      Returns JSONEncodable<APIEmbed>
Returns PaginationEmbed
- Defined in src/lib/pagination/PaginationEmbed.ts:487

addFields

addFields(...fields): PaginationEmbed
Appends fields to the embed

Remarks
This method accepts either an array of fields or a variable number of field parameters. The maximum amount of fields that can be added is 25.

Example
Using an array
```
const fields: APIEmbedField[] = ...;
const pagination = new Pagination(interaction)
    .addFields(fields);
```
Example
Using rest parameters (variadic)
```
const pagination = new Pagination(interaction)
    .addFields(
        { name: 'Field 1', value: 'Value 1' },
        { name: 'Field 2', value: 'Value 2' },
    );
```
Parameters
- Rest ...fields: RestOrArray<APIEmbedField>
  
  The fields to add
Returns PaginationEmbed
Overrides EmbedBuilder.addFields
- Defined in src/lib/pagination/PaginationEmbed.ts:278

addImages

addImages(...images): PaginationEmbed
Adds multiple pagination images.

Example
```
const pagination = new Pagination(interaction)
 .setImages(["1st image", "2nd image", "3rd image"])
 .addImages(["4st image", "5nd image", "6rd image"]);
```
Parameters
- Rest ...images: RestOrArray<string>
  
  The images to set
Returns PaginationEmbed
- Defined in src/lib/pagination/PaginationEmbed.ts:411

`Protected` goFirst

goFirst(interaction): Promise<void>
Goes to the first page.

Example
```
const pagination = new Pagination(interaction);
...
pagination.goFirst(i);
```
Parameters
- interaction: ButtonInteraction<CacheType>
  
  The interaction to reply to
Returns Promise<void>
- Defined in src/lib/pagination/PaginationEmbed.ts:903

`Protected` goLast

goLast(interaction): Promise<void>
Goes to the last page.

Example
```
const pagination = new Pagination(interaction);
...
pagination.goLast(i);
```
Parameters
- interaction: ButtonInteraction<CacheType>
  
  The interaction to reply to
Returns Promise<void>
- Defined in src/lib/pagination/PaginationEmbed.ts:980

`Protected` goNext

goNext(interaction): Promise<void>
Goes to the next page.

Example
```
const pagination = new Pagination(interaction);
...
pagination.goNext(i);
```
Parameters
- interaction: ButtonInteraction<CacheType>
  
  The interaction to reply to
Returns Promise<void>
- Defined in src/lib/pagination/PaginationEmbed.ts:955

`Protected` goPrev

goPrev(interaction): Promise<void>
Goes to the previous page.

Example
```
const pagination = new Pagination(interaction);
...
pagination.goPrev(i);
```
Parameters
- interaction: ButtonInteraction<CacheType>
  
  The interaction to reply to
Returns Promise<void>
- Defined in src/lib/pagination/PaginationEmbed.ts:930

goToPage

goToPage(pageNumber): PaginationEmbed
Triggers the pagination to go to a specific page.

Example
```
const pagination = new Pagination(interaction)
 .setLimit(1)
 .setDescriptions(["1st page", "2nd page", "3rd page", "4th page", "5th page"]);
...
pagination.goToPage(2);
```
Parameters
- pageNumber: number
  
  The page number to jump to
Returns PaginationEmbed
- Defined in src/lib/pagination/PaginationEmbed.ts:810

paginateFields

paginateFields(paginate?): PaginationEmbed
Paginates through fields. It will be ignored if you are not paginating through fields.

Example
```
const pagination = new Pagination(interaction)
 .setFields([{
   name: "Field 1",
   value: "Field 1 value",
 },
 {
   name: "Field 2",
   value: "Field 2 value",
 }])
 .paginateFields();
```
Parameters
- paginate: boolean = true
  
  Whether to paginate fields
Returns PaginationEmbed
- Defined in src/lib/pagination/PaginationEmbed.ts:516

ready

ready(): Payload
Prepares the pagination.

Example
```
const pagination = new Pagination(interaction);
...
pagination.ready();
```
Returns Payload
- Defined in src/lib/pagination/PaginationEmbed.ts:878

setAttachments

setAttachments(attachments): PaginationEmbed
Sends an attachment along with the embed.

Example
```
const pagination = new Pagination(interaction)
 .setAttachments([new AttachmentBuilder()]);
```
Parameters
- attachments: (BufferResolvable | Stream | JSONEncodable<APIAttachment> | Attachment | AttachmentBuilder | AttachmentPayload)[]
  
  The attachments to set
Returns PaginationEmbed
- Defined in src/lib/pagination/PaginationEmbed.ts:757

setAuthor

setAuthor(options): PaginationEmbed
Sets the author of this embed.
Parameters
- options: null | EmbedAuthorOptions
  
  The options to use
Returns PaginationEmbed
Inherited from EmbedBuilder.setAuthor
- Defined in node_modules/@discordjs/builders/dist/index.d.ts:241

setButtonAppearance

setButtonAppearance(options): PaginationEmbed

Customizes the styles of each button.

Example

const pagination = new Pagination(interaction)
 .setButtonAppearance({
   first: {
     label: "First",
     emoji: ":first_emoji:",
     style: ButtonStyle.Secondary
   }
 });

Parameters

options: ButtonsOptions

The styles of the buttons

Returns PaginationEmbed

setButtons

setButtons(buttons?): PaginationEmbed
Set pagination buttons
Parameters
- Optional buttons: Record<string, ButtonBuilder>
  
  The buttons to set
Returns PaginationEmbed
- Defined in src/lib/pagination/PaginationEmbed.ts:715

setColor

setColor(color): PaginationEmbed
Parameters
- color: null | ColorResolvable
Returns PaginationEmbed
Inherited from EmbedBuilder.setColor
- Defined in node_modules/discord.js/typings/index.d.ts:853

setContents

setContents(contents): PaginationEmbed
Sends contents along with the embed.

Example
```
const pagination = new Pagination(interaction)
 .setContents(["this is the first page", "this is the second page"]);
```
Parameters
- contents: null | string | (null | string)[]
  
  The contents to send.
Returns PaginationEmbed
- Defined in src/lib/pagination/PaginationEmbed.ts:862

setDescription

setDescription(description): PaginationEmbed
Sets the description of this embed.
Parameters
- description: null | string
  
  The description to use
Returns PaginationEmbed
Inherited from EmbedBuilder.setDescription
- Defined in node_modules/@discordjs/builders/dist/index.d.ts:253

setDescriptions

setDescriptions(...descriptions): PaginationEmbed
Sets the pagination descriptions.

Example
```
const pagination = new Pagination(interaction)
 .setDescriptions(["1st description", "2nd description", "3rd description"]);
```
Parameters
- Rest ...descriptions: RestOrArray<string>
  
  The descriptions to set
Returns PaginationEmbed
- Defined in src/lib/pagination/PaginationEmbed.ts:427

setEmbeds

setEmbeds(embeds, template?): PaginationEmbed
Sets the pagination embeds. Note: if you set this then all other pagination methods and embed methods will be ignored i.e., descriptions, images, fields, also the embed properties like title, footer and all

Example
```
const pagination = new Pagination(interaction)
 .setEmbeds([new EmbedBuilder(), new EmbedBuilder(), new EmbedBuilder()]);
```
Parameters
- embeds: (APIEmbed | JSONEncodable<APIEmbed>)[]
  
  The embeds to set
- Optional template: ((embed, i, array) => JSONEncodable<APIEmbed>)
  
  A template function that will be called for each embed.
  - - (embed, i, array): JSONEncodable<APIEmbed>
    - Parameters
      
      embed: EmbedBuilder
      
      i: number
      
      array: (APIEmbed | JSONEncodable<APIEmbed>)[]
      
      Returns JSONEncodable<APIEmbed>
Returns PaginationEmbed
- Defined in src/lib/pagination/PaginationEmbed.ts:463

setEmojis

setEmojis(emojiOptions): PaginationEmbed

Sets the emojis for the buttons.

Example

const pagination = new Pagination(interaction)
 .setEmojis({
   firstEmoji: ":first_emoji:",
   prevEmoji: ":prev_emoji:",
   nextEmoji: ":next_emoji:",
   lastEmoji: ":last_emoji:"
 });

Parameters

emojiOptions: Partial<EmojiOptions>

The emoji options to set

Returns PaginationEmbed

setEphemeral

setEphemeral(ephemeral?): PaginationEmbed
Set whether the pagination reply should be ephemeral or not.

Example
```
const pagination = new Pagination(interaction)
 .setEphemeral(true);
```
Parameters
- ephemeral: boolean = true
  
  Whether the reply should be ephemeral
Returns PaginationEmbed
- Defined in src/lib/pagination/PaginationEmbed.ts:547

setFields

setFields(...fields): PaginationEmbed
Sets the embed's fields

Remarks
This method is an alias for spliceFields. More specifically, it splices the entire array of fields, replacing them with the provided fields.

You can set a maximum of 25 fields.
Parameters
- Rest ...fields: RestOrArray<APIEmbedField>
  
  The fields to set
Returns PaginationEmbed
Overrides EmbedBuilder.setFields
- Defined in src/lib/pagination/PaginationEmbed.ts:328

setFooter

setFooter(options): PaginationEmbed
Sets the footer of this embed.
Parameters
- options: null | EmbedFooterOptions
  
  The footer to use
Returns PaginationEmbed
Inherited from EmbedBuilder.setFooter
- Defined in node_modules/@discordjs/builders/dist/index.d.ts:259

setIdle

setIdle(idle): PaginationEmbed
Sets the idle time before closing for the pagination.

Example
```
const pagination = new Pagination(interaction)
 .setIdle(5 * 60 * 1000);
```
Parameters
- idle: number
  
  The idle time
Returns PaginationEmbed
- Defined in src/lib/pagination/PaginationEmbed.ts:531

setImage

setImage(url): PaginationEmbed
Sets the image of this embed.
Parameters
- url: null | string
  
  The image URL to use
Returns PaginationEmbed
Inherited from EmbedBuilder.setImage
- Defined in node_modules/@discordjs/builders/dist/index.d.ts:265

setImages

setImages(...images): PaginationEmbed
Sets the pagination images.

Example
```
const pagination = new Pagination(interaction)
 .setImages(["1st image", "2nd image", "3rd image"]);
```
Parameters
- Rest ...images: RestOrArray<string>
  
  The images to set
Returns PaginationEmbed
- Defined in src/lib/pagination/PaginationEmbed.ts:394

setLabels

setLabels(labelOptions): PaginationEmbed
Sets the labels for the buttons.

Example
```
const pagination = new Pagination(interaction)
 .setLabels({
   firstLabel: "first",
   prevLabel: "prev",
   nextLabel: "next",
   lastLabel: "last"
 });
```
Parameters
- labelOptions: Partial<LabelOptions>
  
  The label options to set
Returns PaginationEmbed
- Defined in src/lib/pagination/PaginationEmbed.ts:642

setLimit

setLimit(limit): PaginationEmbed
Sets the limit of entries per page for pagination.

Example
```
const pagination = new Pagination(interaction)
 .setLimit(5);
```
Parameters
- limit: number
  
  Limit of entries per page
Returns PaginationEmbed
- Defined in src/lib/pagination/PaginationEmbed.ts:563

setOptions

setOptions(options): PaginationEmbed

Sets the pagination options.

Example

const pagination = new Pagination(interaction)
 .setOptions({
   firstEmoji: "⏮",
   prevEmoji: "◀️",
   nextEmoji: "▶️",
   lastEmoji: "⏭",
   limit: 5,
   idle: 5 * 60 * 1000,
   ephemeral: false,
   prevDescription: "",
   postDescription: "",
   attachments: [],
   buttonStyle: ButtonStyle.Secondary,
   loop: false,
 });

Parameters

options: Partial<Options>

The pagination options

Returns PaginationEmbed

setPostDescription

setPostDescription(postDescription): PaginationEmbed
Sets a fixed post description which will be shown in all pages after the paginated descriptions. It will be ignored if you are not paginating through descriptions.

Example
```
const pagination = new Pagination(interaction)
 .setPostDescription("role id: 123456789");
```
Parameters
- postDescription: string
  
  The post description to set
Returns PaginationEmbed
- Defined in src/lib/pagination/PaginationEmbed.ts:597

setPrevDescription

setPrevDescription(prevDescription): PaginationEmbed
Sets a fixed prev description which will be shown in all pages before the paginated descriptions. It will be ignored if you are not paginating through descriptions.

Example
```
const pagination = new Pagination(interaction)
 .setPrevDescription("role info");
```
Parameters
- prevDescription: string
  
  The prev description to set
Returns PaginationEmbed
- Defined in src/lib/pagination/PaginationEmbed.ts:580

setStyle

setStyle(style): PaginationEmbed
Sets the buttons' style.

Example
```
const pagination = new Pagination(interaction)
 .setStyle(ButtonStyle.Secondary);
```
Parameters
- style: PButtonStyle
  
  The style of the buttons
Returns PaginationEmbed
- Defined in src/lib/pagination/PaginationEmbed.ts:661

setThumbnail

setThumbnail(url): PaginationEmbed
Sets the thumbnail of this embed.
Parameters
- url: null | string
  
  The thumbnail URL to use
Returns PaginationEmbed
Inherited from EmbedBuilder.setThumbnail
- Defined in node_modules/@discordjs/builders/dist/index.d.ts:271

setTimestamp

setTimestamp(timestamp?): PaginationEmbed
Sets the timestamp of this embed.
Parameters
- Optional timestamp: null | number | Date
  
  The timestamp or date to use
Returns PaginationEmbed
Inherited from EmbedBuilder.setTimestamp
- Defined in node_modules/@discordjs/builders/dist/index.d.ts:277

setTitle

setTitle(title): PaginationEmbed
Sets the title for this embed.
Parameters
- title: null | string
  
  The title to use
Returns PaginationEmbed
Inherited from EmbedBuilder.setTitle
- Defined in node_modules/@discordjs/builders/dist/index.d.ts:283

setURL

setURL(url): PaginationEmbed
Sets the URL of this embed.
Parameters
- url: null | string
  
  The URL to use
Returns PaginationEmbed
Inherited from EmbedBuilder.setURL
- Defined in node_modules/@discordjs/builders/dist/index.d.ts:289

spliceFields

spliceFields(index, deleteCount, ...fields): PaginationEmbed
Removes, replaces, or inserts fields in the embed.

Remarks
This method behaves similarly to Array.prototype.splice. The maximum amount of fields that can be added is 25.

It's useful for modifying and adjusting order of the already-existing fields of an embed.

Example
Remove the first field
```
pagination.spliceFields(0, 1);
```
Example
Remove the first n fields
```
const n = 4
pagination.spliceFields(0, n);
```
Example
Remove the last field
```
pagination.spliceFields(-1, 1);
```
Parameters
- index: number
  
  The index to start at
- deleteCount: number
  
  The number of fields to remove
- Rest ...fields: APIEmbedField[]
  
  The replacing field objects
Returns PaginationEmbed
Overrides EmbedBuilder.spliceFields
- Defined in src/lib/pagination/PaginationEmbed.ts:312

toJSON

toJSON(): APIEmbed
Serializes this builder to API-compatible JSON data.

Remarks
This method runs validations on the data before serializing it. As such, it may throw an error if the data is invalid.

Returns APIEmbed
Inherited from EmbedBuilder.toJSON
- Defined in node_modules/@discordjs/builders/dist/index.d.ts:297

`Static` from

from(other): EmbedBuilder
Parameters
- other: APIEmbed | JSONEncodable<APIEmbed>
Returns EmbedBuilder
Inherited from EmbedBuilder.from
- Defined in node_modules/discord.js/typings/index.d.ts:854

Class PaginationEmbedAbstract

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Example

Parameters

options: Partial<Options> = {}

Returns PaginationEmbed

Properties

actionRows

attachments

Default Value

Readonly buttonInfo

Default Value

buttons

Private Optional changedButtons

Private contents

Default Value

currentPage

Private customFooter

Readonly data

descriptions

embeds

Default Value

ephemeral

Default Value

Private Readonly extraRows

Default Value

fieldPaginate

Default Value

idle

Default Value

images

limit

Default Value

loop

Default Value

Private Readonly mainActionRow

Private Readonly payload

postDescription

Default Value

prevDescription

Default Value

Private rawFields

Private rawFooter

totalEntry

totalPages

Methods

Private _readyActionRows

Returns PaginationEmbed

Private _readyButton

Parameters

button: ButtonBuilder

label: undefined | string

emoji: undefined | ComponentEmojiResolvable

style: PButtonStyle

Returns PaginationEmbed

Private _readyPayloads

Returns Payload

addActionRows

Example

Parameters

actionRows: ActionRowBuilder<MessageActionRowComponentBuilder>[]

position: ExtraRowPosition = ExtraRowPosition.Below

Returns PaginationEmbed

addAttachment

Example

Parameters

attachment: BufferResolvable | Stream | JSONEncodable<APIAttachment> | Attachment | AttachmentBuilder | AttachmentPayload

Returns PaginationEmbed

addAttachments

Example

Parameters

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

Returns PaginationEmbed

addDescriptions

Class PaginationEmbed`Abstract`

`Readonly` buttonInfo

`Private` `Optional` changedButtons

`Private` contents

`Private` customFooter

`Readonly` data

`Private` `Readonly` extraRows

`Private` `Readonly` mainActionRow

`Private` `Readonly` payload

`Private` rawFields

`Private` rawFooter

`Private` _readyActionRows

`Private` _readyButton

`Private` _readyPayloads

`Rest` ...descriptions: RestOrArray<string>

`Optional` template: ((embed) => JSONEncodable<APIEmbed>)

`Rest` ...fields: RestOrArray<APIEmbedField>

`Rest` ...images: RestOrArray<string>

`Protected` goFirst

`Protected` goLast

`Protected` goNext

`Protected` goPrev