paginatocord v1.0.4

Paginatocord

📝 D E T A I L S:

• This package is very usefull for those who are looking for a very easy to use and customize pagination for discord embeds.
• This package can work with both slash command bots and prefix bots!

⚙ I N S T A L L A T I O N:

• to use this package, You can install it thru npm

npm install paginatocord@latest

💻 F U N C T I O N S:

To set this up, this package returns a class when required. We can use that class to configure the pagination system however we want!

const Paginator = require("paginatocord")
const Settings = new Paginator({
    superSkip: true // [OPTIONAL] enables super skip feature
    lastButton: {
        text: "⏩", // [OPTIONAL] the text of the super skip last page button.
        style: 1 // [OPTIONAL] style of the button. Can be any number from 1 to 3.
    },
    firstButton: {
        text: "⏪", // [OPTIONAL] the text of the super skip first page button.
        style: 1 // [OPTIONAL] style of the button. Can be any number from 1 to 3.
    }
    errors: {
        previous: "This is the first page!", // [OPTIONAL] displays when no more pages behind.
        next: "This is the last page!" // [OPTIONAL] displays when no more pages left.
    },
    previousButton: {
        text: "◀", // [OPTIONAL] the text of the previous page button.
        style: 1 // [OPTIONAL] style of the button. Can be any number from 1 to 3.
    },
    nextButton: {
        text: "▶", // [OPTIONAL] the text of the next page button.
        style: 1 // [OPTIONAL] style of the button. Can be any number from 1 to 3.
    },
    timeoutInSeconds: 30, // [OPTIONAL] timeout time. Will reset on button press. Timeouts when no input.
    displayPages: true, // [OPTIONAL] displays the current page and total pages. Comes with watermark.
    isInteraction: false // <REQUIRED> set true if your bot uses slash commands, false if it doesnt.
})

When the class is configured, The the .paginate() function can be used

.paginate() The function that paginates the embeds.

• Parameters:

1. Message: the message or the interaction recieved
2. The embeds that have to be paginated (Must be given in an array)

client.on("messageCreate", async message => {
    if (message.content === "!embedtest") {
        const embeds = [
            new discord.EmbedBuilder()
            .setDescription("Embed 1")
            .setColor("Random"),
            new discord.EmbedBuilder()
            .setDescription("Embed 2")
            .setColor("Random"),
            new discord.EmbedBuilder()
            .setDescription("Embed 3")
            .setColor("Random"),
            new discord.EmbedBuilder()
            .setDescription("Embed 4")
            .setColor("Random")
        ]
        await Settings.paginate(message, embeds)
    }
})

👀 P R E V I E W:

📒 U P D A T E S:

v1.0.4 (20 Feb 2025): Added super skip feature