mirror of https://github.com/i-Moony/djs-button-pages.git synced 2025-12-09 23:57:12 +03:00

Simple yet powerful and extensible module to create fully-customizable embed pages with buttons. https://i-moony.github.io/djs-button-pages/

discord discord-js pagination

Find a file

m00ny 180820f9a7 chore README: change badges and refine text		2023-05-25 16:53:15 +03:00
.github	chore: merge build & test workflows	2022-12-18 15:02:23 +03:00
assets	chore: convert showcase to gif	2023-05-25 16:25:30 +03:00
examples	docs: update examples	2022-12-16 20:15:10 +03:00
packages	chore: update package version	2023-02-28 00:00:34 +03:00
.eslintignore	chore eslintignore: add examples folder	2022-11-24 20:22:56 +03:00
.eslintrc	chore: remove prettier from eslint config	2022-11-23 15:35:24 +03:00
.gitattributes	chore: convert showcase to gif	2023-05-25 16:25:30 +03:00
.gitignore	chore: add .gitignore	2022-11-23 10:27:45 +03:00
LICENSE.md	chore: add licenses	2022-11-23 12:12:17 +03:00
package-lock.json	chore: deps	2022-12-10 21:04:54 +03:00
package.json	chore: add jest	2022-12-10 21:04:47 +03:00
README.md	chore README: change badges and refine text	2023-05-25 16:53:15 +03:00
TODO.md	chore: add TODO	2022-12-16 19:45:35 +03:00
tsconfig.json	chore: fix typescript module config	2022-12-11 00:01:53 +03:00
VERSIONING.md	chore: add versioining rules	2022-12-18 13:29:18 +03:00

README.md

📚 About package:

Simple yet powerful and extensible module to create fully-customizable embed pages with buttons.

▶️ Works with Discord.JS. Supports v14. Legacy versions support v13 and v14.

▶️ This packages supports creation of custom buttons with your own scripts through a simple API.

▶️ If you want some pre-built buttons consider using @djs-button-pages/presets. They contain basic ones (But you can contribute some of your own to this package if you want to).

📥 Installation:

Requires Node 16.9 (because of Discord.JS).

npm install djs-button-pages

yarn add djs-button-pages

pnpm install djs-button-pages

There are several other branches:

djs14-legacy
djs13
djs13-legacy

📃 Examples:

Basic example:

// Imports.
const { Client, EmbedBuilder, ButtonStyle } = require("discord.js");
const { PaginationWrapper } = require("djs-button-pages");
// Pre-made buttons.
const { NextPageButton, PreviousPageButton } = require('@djs-button-pages/presets');

const embeds =
[
    // Array of embeds for pagination.
];

// Array of buttons for pagination.
const buttons =
[
    new PreviousPageButton
    ({
        custom_id: "prev_page",
        emoji: "◀",
        style: ButtonStyle.Secondary
    }),
    new NextPageButton
    ({
        custom_id: "next_page",
        emoji: "▶",
        style: ButtonStyle.Secondary
    }),
];

// No intents needed for this example.
const client = new Client({intents: []});

// Catch command.
client.on("interactionCreate", async (interaction) => {
    if (interaction.isCommand() && interaction.commandName === "pages")
    {
        // Setup pagination.
        const pagination = new PaginationWrapper()
            .setButtons(buttons)
            .setEmbeds(embeds)
            .setTime(60000);

        // Send it as a reply to interaction.
        await pagination.interactionReply(interaction);
        // Everything else will be done for you!
    };
});

More interesting examples with commentary can be found at GitHub page.

❔ Links:

🐛 Bug Reporting:

For bug reporting look for GitHub Issues.

If you need support, you can join my Discord Server.

© License:

Licensed under the Apache License, Version 2.0.