Skip to content

cataclym/discord.js-pagination

 
 

Repository files navigation

discord-js-button-pagination-ts

npm version

Heavily modified jellz' discord.js-pagination, changed to use buttons.

  • Buttons, with custom emoji
  • Select start page
  • Allow a specific member, or everyone to use buttons
  • Paginate Embeds and or messageOptions, or mix both!

This allows unique pagination of messages with only text on one page and multiple embeds on next page!

Requirements

discord.js ^14.14.1 - Or newer

Quick overview

General Usage

import { sendPaginatedMessage } from "discord-js-button-pagination-ts";
import { Message, EmbedBuilder } from "discord.js";

new command("Example command", async (message: Message) => {
    const pages = [new EmbedBuilder()
        .setDescription("Page 1"),
        // Pages can be the BaseMessageOptions object
        {
            content: "Page 2",
            embeds: [
                new EmbedBuilder()
                    .setDescription("Embed on page 2"),
                new EmbedBuilder()
                    .setDescription("Another embed on page 2")],
        }];
    
    await sendPaginatedMessage(message, pages, { owner: message.author, timeout: 30000 });
});

Setting custom emojis and allowing everyone

await sendPaginatedMessage(message, pages, { allowEveryone: true, emojiList: ['👈', '👉'] });

ko-fi

About

jellz' discord.js-pagination Modified and changed to use buttons.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 91.9%
  • JavaScript 8.1%