@novelbrasil/discord.js-embed-menu

<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>discord.js-embed-menu</title> <meta name="description" content="Documentation for discord.js-embed-menu"> <meta name="viewport" content="width=device-width, initial-scale=1"> <link rel="stylesheet" href="assets/css/main.css"> <script async src="assets/js/search.js" id="search-script"></script> </head> <body> <header> <div class="tsd-page-toolbar"> <div class="container"> <div class="table-wrap"> <div class="table-cell" id="tsd-search" data-index="assets/js/search.json" data-base="."> <div class="field"> <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label> <input id="tsd-search-field" type="text" /> </div> <ul class="results"> <li class="state loading">Preparing search index...</li> <li class="state failure">The search index is not available</li> </ul> <a href="index.html" class="title">discord.js-embed-menu</a> </div> <div class="table-cell" id="tsd-widgets"> <div id="tsd-filter"> <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a> <div class="tsd-filter-group"> <div class="tsd-select" id="tsd-filter-visibility"> All <ul class="tsd-select-list"> <li data-value="public">Public</li> <li data-value="protected">Public/Protected</li> <li data-value="private" class="selected">All</li> </ul> </div> <input type="checkbox" id="tsd-filter-inherited" checked /> <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label> <input type="checkbox" id="tsd-filter-externals" checked /> <label class="tsd-widget" for="tsd-filter-externals">Externals</label> </div> </div> <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a> </div> </div> </div> </div> <div class="tsd-page-title"> <div class="container"> <h1>discord.js-embed-menu</h1> </div> </div> </header> <div class="container container-main"> <div class="row"> <div class="col-8 col-content"> <div class="tsd-panel tsd-typography"> <div align="center"> <a href="https://github.com/eilex/discord.js-embed-menu"><img src="https://img.shields.io/npm/v/discord.js-embed-menu" alt="NPM version" /></a> <a href="https://discord.js.org"><img src="https://img.shields.io/npm/dependency-version/discord.js-embed-menu/discord.js" alt="NPM (prod) dependency version" /></a> <a href="https://nodei.co/npm/discord.js-embed-menu"><img src="https://img.shields.io/npm/dt/discord.js-embed-menu" alt="NPM downloads" /></a> <a href="https://nodei.co/npm/discord.js-embed-menu"><img src="https://img.shields.io/npm/dw/discord.js-embed-menu" alt="NPM downloads week" /></a> <a href="https://nodei.co/npm/discord.js-embed-menu/"><img src="https://nodei.co/npm/discord.js-embed-menu.png?downloads=true&stars=true" alt="npm installnfo" /></a> </div> <a href="#table-of-contents" id="table-of-contents" style="color: inherit; text-decoration: none;"> <h2>Table of contents</h2> </a> <ul> <li><a href="#about">About</a></li> <li><a href="#installation">Installation</a></li> <li><a href="#example-usage">Example usage</a></li> <li><a href="#special-destinations">Special destinations</a></li> <li><a href="#contributing">Contributing</a></li> <li><a href="#links">Links</a></li> </ul> <a href="#about" id="about" style="color: inherit; text-decoration: none;"> <h2>About</h2> </a> discord.js-embed-menu is a <a href="https://nodejs.org">Node.js</a> module based on <a href="https://github.com/jowsey/discord.js-menu">discord.js-menu</a> that allows you to easily create reaction embeds menu using <a href="https://discord.js.org/#/">discord.js</a>. <ul> <li>Channel and direct message menu</li> <li>Remove other users reactions</li> <li>Pagination system</li> <li>Mention user</li> <li>Timeout and auto delete</li> </ul> <a href="#installation" id="installation" style="color: inherit; text-decoration: none;"> <h2>Installation</h2> </a> Node.js 14.0.0 or newer is required. <pre><code class="language-shell">npm i discord.js-embed-menu --save </code></pre> <a href="#example-usage" id="example-usage" style="color: inherit; text-decoration: none;"> <h2>Example usage</h2> </a> <pre><code class="language-js">/* Import all the usual stuff. */ import { Client, MessageEmbed } from 'discord.js'; import { DiscordEmbedMenu } from 'discord.js-embed-menu'; const client = new Client(); /* Run this code every time a new message is sent. */ client.on('message', message => { if (message.content === '!menu') { /* * The menu class takes 3 mandatory parameters and 5 optional parameters. * 1) A channel to send the menu to, it can be null so it will send DMs to the user. * 2) A user to give control over the navigation or send DM if channel is null. * 3) An array of Page objects or DiscordEmbedMenuPage, each being a unique page of the menu. * 4) How long, in milliseconds, you want the menu to wait for new reactions, it can be null so it will wait for ever (not recommended). * 5) If it shall or not delete the message on menu timeout. * 6) If it shall mention menu's user on discord channels. * 7) If it shall keep last user reaction when you call stop. * 8) The message to be displayed when it's loading the menu page. */ let menu = new DiscordEmbedMenu(message.channel, message.author, [ { /* * A page object consists of three items: * 1) A name. This is used as a unique destination name for reactions. * 2) Some content. This is a rich embed. You can use {object: formatting} or .functionFormatting() for embeds. Whichever you prefer. * 3) A set of reactions, linked to either a page destination or a function.* (See example pages) * * Reactions can be emojis or custom emote IDs, and reaction destinations can be either the names * of pages, () => { functions }, or special destination names. See below for a list of these. */ /* You can call pages whatever you like. The first in the array is always loaded first. */ name: 'main', content: new MessageEmbed({ title: 'Main menu', description: 'Please chose an action', fields: [ { name: "📝 Sub menu", value: "Goes to another menu.", inline: false }, { name: "✉️ Direct message", value: "Sends a direct message.", inline: false }, { name: "❌ Close", value: "Close the menu.", inline: false } ] }), reactions: { '📝': 'sub-menu', '✉️': async (menu) => { menu.user.send(`Hello dear ${menu.user.username}.`); }, '❌': 'delete' } }, { name: 'sub-menu', content: new MessageEmbed({ title: 'Sub menu', description: 'This is another page.', fields: [ { name: "⬅️ Back", value: "Go backwards.", inline: false }, { name: "❌ Close", value: "Close the menu.", inline: false } ] }), reactions: { '⬅️': 'main', '❌': 'delete' } } ]); /* Run Menu.start() when you're ready to send the menu. */ menu.start(); /* The menu also has two events you can use. * The "page-changing" event fires just before a new page is sent. * The "page-changed" event fires after the new page is sent. */ menu.on('page-changing', (oldPageIndex, oldPage, newPageIndex, newPage) => { console.log(`Menu is going from "${oldPage.content.title}" (${oldPageIndex}) to "${newPage.content.title}" (${newPageIndex})`); }); menu.on('page-changed', (pageIndex, page) => { console.log(`Menu is now on "${page.content.title}" (${pageIndex})`); }); } }); client.login("Get your bot's oauth token at https://discord.com/developers/applications"); </code></pre> <a href="#special-destinations" id="special-destinations" style="color: inherit; text-decoration: none;"> <h2>Special Destinations</h2> </a> Discord.js-embed-menu comes with 6 pre-defined destinations with specific uses. <table> <thead> <tr> <th>Destination</th> <th>Function</th> </tr> </thead> <tbody><tr> <td>first</td> <td>Goes to the first page in the array.</td> </tr> <tr> <td>last</td> <td>Goes to the last page in the array.</td> </tr> <tr> <td>previous</td> <td>Goes to the previous page in the array.</td> </tr> <tr> <td>next</td> <td>Goes to the next page in the array.</td> </tr> <tr> <td>stop</td> <td>Removes reactions from the embed and stops updating the menu.</td> </tr> <tr> <td>delete</td> <td>Stops the menu and deletes the message.</td> </tr> </tbody></table> Calling a page one of these wouldn't work, it prioritizes special destinations. <a href="#contributing" id="contributing" style="color: inherit; text-decoration: none;"> <h2>Contributing</h2> </a> Before creating an issue, please ensure that it hasn't already been reported/suggested. <a href="#links" id="links" style="color: inherit; text-decoration: none;"> <h2>Links</h2> </a> <ul> <li><a href="https://github.com/discordjs/discord.js">discord.js</a></li> <li><a href="https://github.com/jowsey/discord.js-menu">discord.js-menu</a></li> </ul> </div> </div> <div class="col-4 col-menu menu-sticky-wrap menu-highlight"> <nav class="tsd-navigation primary"> <ul> <li class=" "> <a href="modules.html">Exports</a> </li> </ul> </nav> <nav class="tsd-navigation secondary menu-sticky"> <ul class="before-current"> <li class=" tsd-kind-class"> <a href="classes/discordembedmenu.html" class="tsd-kind-icon">DiscordEmbedMenu</a> </li> <li class=" tsd-kind-class"> <a href="classes/discordembedmenupage.html" class="tsd-kind-icon">DiscordEmbedMenuPage</a> </li> </ul> </nav> </div> </div> </div> <footer class="with-border-bottom"> <div class="container"> <h2>Legend</h2> <div class="tsd-legend-group"> <ul class="tsd-legend"> <li class="tsd-kind-constructor tsd-parent-kind-class">Constructor</li> <li class="tsd-kind-property tsd-parent-kind-class">Property</li> <li class="tsd-kind-method tsd-parent-kind-class">Method</li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private">Private property</li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private">Private method</li> </ul> </div> </div> </footer> <div class="container tsd-generator"> Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a> </div> <div class="overlay"></div> <script src="assets/js/main.js"></script> </body> </html>