Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ppodds/discord.js-message-listener
A simple utility to bind events on discord message.
https://github.com/ppodds/discord.js-message-listener
button discord discord-bot discord-js listener paginator
Last synced: about 1 month ago
JSON representation
A simple utility to bind events on discord message.
- Host: GitHub
- URL: https://github.com/ppodds/discord.js-message-listener
- Owner: ppodds
- License: mit
- Created: 2022-03-25T05:57:12.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2024-06-17T20:31:04.000Z (8 months ago)
- Last Synced: 2024-11-07T08:46:25.067Z (3 months ago)
- Topics: button, discord, discord-bot, discord-js, listener, paginator
- Language: TypeScript
- Homepage:
- Size: 943 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# discord.js-message-listener
[](https://www.codacy.com/gh/ppodds/discord.js-message-listener/dashboard?utm_source=github.com&utm_medium=referral&utm_content=ppodds/discord.js-message-listener&utm_campaign=Badge_Grade)
[](https://codecov.io/gh/ppodds/discord.js-message-listener)
[](https://www.npmjs.com/package/discord.js-message-listener)
A simple utility to bind events on discord message.
You can use this library to listen message interaction, and react to it. For example, you can do a embed message with pagination, or a selector to choose a option.
## Features
- Listen message component interaction
- Button
- Select menu
- High flexibility and Extentable
- Custom message content and component
- Mulitple action row
- With simple utility
- Paginator
## Installation
```shell
# if you are using discord.js v13
npm i discord.js-message-listener@^2.0.0
# v14
npm i discord.js-message-listener
```
## Example
Examples can be found in [example bot](https://github.com/ppodds/discord.js-message-listener/blob/master/example/index.ts).
## Usage
### Listener
All listener provide a same interface to operate. You can use it like this:
```typescript
// it is psudocode
const listener = new Listener(message, { collectorOptions });
listener.on("collect", (arg) => console.log("collect", arg));
listener.on("collectError", (error) => console.log(error));
listener.on("end", (collected, reason) => console.log("listenerEnd"));
await listener.start(); // it would perform some required action
```
#### ActionRowMessageListener
```typescript
import { ActionRowMessageListener } from "discord.js-message-listener";
```
ActionRowMessageListener provide a simple way to create action rows and listen to them.
To use it, you need to pass a message, and a list of action row to it. It will edit the message to show the action row and listen to it.
```typescript
const messageActionRow = new ActionRowBuilder();
const btn1 = new ButtonBuilder();
const btn2 = new ButtonBuilder();
btn1.setLabel("1");
btn2.setLabel("2");
messageActionRow.addComponents(btn1, btn2);
const listener = new ActionRowMessageListener(message, {
messageActionRows: [messageActionRow],
collectorOptions: {
time: 10000,
},
});
listener.on(
"collect",
// use as to cast to subclass of Interaction
(arg) => console.log((arg as ButtonInteraction).customId)
);
await listener.start();
```
### Utility
#### Paginator
```typescript
import { Paginator } from "discord.js-message-listener";
```
Paginator provide a simple way to create paginator. It need a message listener to listen to the message. The other thing you need to do is to pass filter functions to it. Because the paginator accept any listener, you can use it flexibly.
> The paginator will bind `collect` event to the listener for you, so you don't need to do it manually.
```typescript
const messageActionRow = new ActionRowBuilder();
const prevPage = new ButtonBuilder();
const nextPage = new ButtonBuilder();
prevPage.setLabel("Prev");
prevPage.setCustomId("prev-btn");
nextPage.setLabel("Next");
nextPage.setCustomId("next-btn");
messageActionRow.addComponents(prevPage, nextPage);
const listener = new ActionRowMessageListener(msg, {
messageActionRows: [messageActionRow],
collectorOptions: {
time: 60000,
},
});
const page1 = new EmbedBuilder();
const page2 = new EmbedBuilder();
page1.setTitle("Page 1");
page2.setTitle("Page 2");
const pages = [page1, page2];
const paginator = new Paginator(listener, {
pages,
nextPageFilter: (arg) => (arg as ButtonInteraction).customId === "next-btn",
previousPageFilter: (arg) =>
(arg as ButtonInteraction).customId === "prev-btn",
});
// you should call start() to start the paginator
// start() will call listener.start() for you
await paginator.start();
```
You can also bind error handler and end handler to the paginator.
> Error handler and end handler will be bind to the listener.
```typescript
const paginator = new Paginator(listener, {
pages,
nextPageFilter: (arg) => (arg as ButtonInteraction).customId === "next-btn",
previousPageFilter: (arg) =>
(arg as ButtonInteraction).customId === "prev-btn",
errorHandler: (error) => {
// to something
console.log(error);
},
endHandler: (collected, reason) => {
// to something
console.log(reason);
},
});
```