djs-menu-v13
Version:
A module for create simple and complex menu for your Discord Bot
1 lines • 19.5 kB
HTML
<html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>djs-menu-v13</title><meta name="description" content="Documentation for djs-menu-v13"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script async src="assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base="."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></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">djs-menu-v13</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"><span class="tsd-select-label">All</span><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>djs-menu-v13</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Classes</h3><ul class="tsd-index-list"><li class="tsd-kind-class"><a href="classes/Menu.html" class="tsd-kind-icon">Menu</a></li><li class="tsd-kind-class"><a href="classes/MenuPage.html" class="tsd-kind-icon">Menu<wbr/>Page</a></li><li class="tsd-kind-class"><a href="classes/MenuSelectPage.html" class="tsd-kind-icon">Menu<wbr/>Select<wbr/>Page</a></li></ul></section><section class="tsd-index-section "><h3>Type aliases</h3><ul class="tsd-index-list"><li class="tsd-kind-type-alias"><a href="modules.html#MenuButton" class="tsd-kind-icon">Menu<wbr/>Button</a></li><li class="tsd-kind-type-alias"><a href="modules.html#MenuSelectChoice" class="tsd-kind-icon">Menu<wbr/>Select<wbr/>Choice</a></li><li class="tsd-kind-type-alias"><a href="modules.html#SelectChoice" class="tsd-kind-icon">Select<wbr/>Choice</a></li><li class="tsd-kind-type-alias"><a href="modules.html#SingleButton" class="tsd-kind-icon">Single<wbr/>Button</a></li><li class="tsd-kind-type-alias"><a href="modules.html#pagesType" class="tsd-kind-icon">pages<wbr/>Type</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Type aliases</h2><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="MenuButton" class="tsd-anchor"></a><h3>Menu<wbr/>Button</h3><div class="tsd-signature tsd-kind-icon">Menu<wbr/>Button<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>emoji<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">EmojiIdentifierResolvable</span><span class="tsd-signature-symbol">; </span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>label<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>style<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">MessageButtonStyleResolvable</span><span class="tsd-signature-symbol">; </span>target<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>page<span class="tsd-signature-symbol">: </span><a href="classes/MenuPage.html" class="tsd-signature-type" data-tsd-kind="Class">MenuPage</a><span class="tsd-signature-symbol"> | </span><a href="classes/MenuSelectPage.html" class="tsd-signature-type" data-tsd-kind="Class">MenuSelectPage</a>, interaction<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CommandInteraction</span>, menu<span class="tsd-signature-symbol">: </span><a href="classes/Menu.html" class="tsd-signature-type" data-tsd-kind="Class">Menu</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span>url<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Shizey/djs-menu-v13/blob/e7e4bb2/src/index.ts#L22">src/index.ts:22</a></li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> emoji<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">EmojiIdentifierResolvable</span></h5></li><li class="tsd-parameter"><h5>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5>label<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5>style<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">MessageButtonStyleResolvable</span></h5></li><li class="tsd-parameter"><h5>target<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>page<span class="tsd-signature-symbol">: </span><a href="classes/MenuPage.html" class="tsd-signature-type" data-tsd-kind="Class">MenuPage</a><span class="tsd-signature-symbol"> | </span><a href="classes/MenuSelectPage.html" class="tsd-signature-type" data-tsd-kind="Class">MenuSelectPage</a>, interaction<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CommandInteraction</span>, menu<span class="tsd-signature-symbol">: </span><a href="classes/Menu.html" class="tsd-signature-type" data-tsd-kind="Class">Menu</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> url<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="MenuSelectChoice" class="tsd-anchor"></a><h3>Menu<wbr/>Select<wbr/>Choice</h3><div class="tsd-signature tsd-kind-icon">Menu<wbr/>Select<wbr/>Choice<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>description<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>emoji<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">EmojiIdentifierResolvable</span><span class="tsd-signature-symbol">; </span>label<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>target<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>page<span class="tsd-signature-symbol">: </span><a href="classes/MenuPage.html" class="tsd-signature-type" data-tsd-kind="Class">MenuPage</a><span class="tsd-signature-symbol"> | </span><a href="classes/MenuSelectPage.html" class="tsd-signature-type" data-tsd-kind="Class">MenuSelectPage</a>, interaction<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CommandInteraction</span>, menu<span class="tsd-signature-symbol">: </span><a href="classes/Menu.html" class="tsd-signature-type" data-tsd-kind="Class">Menu</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Shizey/djs-menu-v13/blob/e7e4bb2/src/index.ts#L42">src/index.ts:42</a></li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> description<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> emoji<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">EmojiIdentifierResolvable</span></h5></li><li class="tsd-parameter"><h5>label<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5>target<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>page<span class="tsd-signature-symbol">: </span><a href="classes/MenuPage.html" class="tsd-signature-type" data-tsd-kind="Class">MenuPage</a><span class="tsd-signature-symbol"> | </span><a href="classes/MenuSelectPage.html" class="tsd-signature-type" data-tsd-kind="Class">MenuSelectPage</a>, interaction<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CommandInteraction</span>, menu<span class="tsd-signature-symbol">: </span><a href="classes/Menu.html" class="tsd-signature-type" data-tsd-kind="Class">Menu</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h5></li><li class="tsd-parameter"><h5>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="SelectChoice" class="tsd-anchor"></a><h3>Select<wbr/>Choice</h3><div class="tsd-signature tsd-kind-icon">Select<wbr/>Choice<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>description<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>emoji<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">EmojiIdentifierResolvable</span><span class="tsd-signature-symbol">; </span>label<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>target<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>page<span class="tsd-signature-symbol">: </span><a href="classes/MenuPage.html" class="tsd-signature-type" data-tsd-kind="Class">MenuPage</a><span class="tsd-signature-symbol"> | </span><a href="classes/MenuSelectPage.html" class="tsd-signature-type" data-tsd-kind="Class">MenuSelectPage</a>, interaction<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CommandInteraction</span>, menu<span class="tsd-signature-symbol">: </span><a href="classes/Menu.html" class="tsd-signature-type" data-tsd-kind="Class">Menu</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Shizey/djs-menu-v13/blob/e7e4bb2/src/index.ts#L33">src/index.ts:33</a></li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> description<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> emoji<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">EmojiIdentifierResolvable</span></h5></li><li class="tsd-parameter"><h5>label<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5>target<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>page<span class="tsd-signature-symbol">: </span><a href="classes/MenuPage.html" class="tsd-signature-type" data-tsd-kind="Class">MenuPage</a><span class="tsd-signature-symbol"> | </span><a href="classes/MenuSelectPage.html" class="tsd-signature-type" data-tsd-kind="Class">MenuSelectPage</a>, interaction<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CommandInteraction</span>, menu<span class="tsd-signature-symbol">: </span><a href="classes/Menu.html" class="tsd-signature-type" data-tsd-kind="Class">Menu</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="SingleButton" class="tsd-anchor"></a><h3>Single<wbr/>Button</h3><div class="tsd-signature tsd-kind-icon">Single<wbr/>Button<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>emoji<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">EmojiIdentifierResolvable</span><span class="tsd-signature-symbol">; </span>label<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>style<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">MessageButtonStyleResolvable</span><span class="tsd-signature-symbol">; </span>target<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>url<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Shizey/djs-menu-v13/blob/e7e4bb2/src/index.ts#L14">src/index.ts:14</a></li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> emoji<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">EmojiIdentifierResolvable</span></h5></li><li class="tsd-parameter"><h5>label<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5>style<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">MessageButtonStyleResolvable</span></h5></li><li class="tsd-parameter"><h5>target<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> url<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="pagesType" class="tsd-anchor"></a><h3>pages<wbr/>Type</h3><div class="tsd-signature tsd-kind-icon">pages<wbr/>Type<span class="tsd-signature-symbol">:</span> <a href="classes/MenuPage.html" class="tsd-signature-type" data-tsd-kind="Class">MenuPage</a><span class="tsd-signature-symbol"> | </span><a href="classes/MenuSelectPage.html" class="tsd-signature-type" data-tsd-kind="Class">MenuSelectPage</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Shizey/djs-menu-v13/blob/e7e4bb2/src/index.ts#L12">src/index.ts:12</a></li></ul></aside></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class="current"><a href="modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="tsd-kind-class"><a href="classes/Menu.html" class="tsd-kind-icon">Menu</a></li><li class="tsd-kind-class"><a href="classes/MenuPage.html" class="tsd-kind-icon">Menu<wbr/>Page</a></li><li class="tsd-kind-class"><a href="classes/MenuSelectPage.html" class="tsd-kind-icon">Menu<wbr/>Select<wbr/>Page</a></li><li class="tsd-kind-type-alias"><a href="modules.html#MenuButton" class="tsd-kind-icon">Menu<wbr/>Button</a></li><li class="tsd-kind-type-alias"><a href="modules.html#MenuSelectChoice" class="tsd-kind-icon">Menu<wbr/>Select<wbr/>Choice</a></li><li class="tsd-kind-type-alias"><a href="modules.html#SelectChoice" class="tsd-kind-icon">Select<wbr/>Choice</a></li><li class="tsd-kind-type-alias"><a href="modules.html#SingleButton" class="tsd-kind-icon">Single<wbr/>Button</a></li><li class="tsd-kind-type-alias"><a href="modules.html#pagesType" class="tsd-kind-icon">pages<wbr/>Type</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"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="assets/main.js"></script></body></html>