Simple JavaScript module for paginating discord embeds and handling corresponding buttons

NOTICES

This module is in BETA RELEASE If you notice any bugs, please open an issue on the repository.

Reporting Issues

Before reporting any issues or suggesting features please visit our Issue Templates to better understand what we consider great issues.

Contributing

We are always interested in contributions! You can see how to contribute here

Example

const { Paginator, Page } = require("discord-pages.js");

// Create paginator instance, tell it how many contents per page we want and how many pages 
const paginator = new Paginator({
  perPage: 5,
  contentType: "MULTIPLE"
});

// Extension of MessageEmbed from discord.js has all the same features as MessageEmbed but with
// Array functionality of addComponents from MessageActionRow in discord.js
paginator.addPages(
  new Page()
    .setTitle("Hello World!")
    .setColor("DEFAULT"),
  new Page()
    .setTitle("Hello Space!")
    .setColor("GOLD")
);

// the array of data to be broken up and placed on the different pages.
paginator.setContents(["1", "2", "3", "4", "5", "6"]);

// Starts the Paginator and sends it to discord (buttons handled within module); 
// sendable = interaction, channel, or member object to send pages to.

// For channel:
await paginator.start(channel, user);

// For interaction:
await paginator.start(interaction, user);

// for User
await paginator.start(user)

The user Parameter in .start(sendable, user); is important for restricting buttons to the specified user. user parameter is only used in sending to a channel or replying to an interaction. It is expected that user will be a APIUser object, NOT Discord Snowflake.

If user parameter is omitted, the paginator buttons will be available to all users with access to the channel the message or interaction is posted to.