# gamemax.paginator

> 💜 Plugin for easy creation and interaction with pages

Latest version **1.0.6** (published 2021-03-05) · MIT license · 0 weekly downloads

## Install

```sh
npm install gamemax.paginator
pnpm add gamemax.paginator
yarn add gamemax.paginator
bun add gamemax.paginator
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.6 |
| Published | 2021-03-05 |
| First published | 2020-12-30 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 8.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | perssBest |
| Maintainers | persigg_loves |
| Keywords | perssBest, paginator, discord-reactions-menu, custom-reactions-menu |

## Links

- npm: https://www.npmjs.com/package/gamemax.paginator
- Repository: https://github.com/nevzorl/gamemax-paginator
- Homepage: https://github.com/nevzorl/gamemax-paginator#readme
- Issues: https://github.com/nevzorl/gamemax-paginator/issues
- npm.io page: https://npm.io/package/gamemax.paginator

## Dependencies (1)

- [events](https://npm.io/package/events.md) ^3.2.0

## Recent versions

- 1.0.6 (latest) — 2021-03-05
- 1.0.5 — 2021-01-06
- 1.0.3 — 2021-01-02
- 1.0.2 — 2021-01-01
- 1.0.1 — 2020-12-31
- 1.0.0 — 2020-12-30

## README

<div align="center" markdown=1>
	<p align="center"><img width=45% src="https://media.discordapp.net/attachments/704388319039193122/793900778149511168/reminder_1.png?width=1001&height=282"></p>
	<strong>Lightweight and very smooth page builder for your bots (discord.js)</strong>
	<br>Check out plugin initialization and configuration below!<br>
	<p></p>
</div>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
[![node.js](https://img.shields.io/badge/node.js-v14-brightgreen)](https://nodejs.org/)
[![Star](https://img.shields.io/badge/-Give%20this%20repo%20a%20star!-yellow)](https://github.com/nevzorl/gamemax-paginator)
[![Discord](https://img.shields.io/discord/732115887246671913?color=8697F6&label=Discord&logo=as&logoColor=%238697F6)](https://discord.gg/RPb2KXN)
[![Donate](https://img.shields.io/badge/donate-%241-orange)](https://www.donationalerts.com/r/reedi)
<p align="center">Click on a badge to learn more.</p>

<p align="center">
  <a href="#%EF%B8%8F-plugin-installation">Installation</a> •
  <a href="/archive/main.zip">Download</a> •
  <a href="#-example-to-use">How to use?</a> •
  <a href="#-plugin-customization">Customization</a>
</p>

## ♻️ Plugin installation:
<img align="right" width="200" height="200" src="https://media.discordapp.net/attachments/704388319039193122/793900776988082186/1.png"> 

Plugin initialization looks like this:
```js
const plugin = require("gamemax.paginator");

[...]
```

You can initialize the plugin to a global variable, which makes the plugin more accessible to you.

```js
require("gamemax.paginator").init(<object>); // Specify your variable (object)

// After that, the plugin will be available along this path:
new <object>.paginator()
```

You can also change the name of the element, for example:

```js
require("gamemax.paginator").init(<object>, "example");

// After that, the plugin will be available along this path:
new <object>.example()
```



## ❓ Example to use: 

```js
const { Pages } = require("gamemax.paginator");
const page = new Pages(message.author.id); // Collector filter.

page.add("Hello"); // You can also specify an array with text: page.add([ "Hello", "Hello 2", etc. ]);
page.create(message.channel); // send message
```


## 🔓 Plugin customization:
You can customize the plugin by adding your own emoji, functions, and custom checks.
```js
new plugin(message.author.id, [
    { emoji: "📌", execute: (channel) => channel.send("This is custom reaction!"), imports: [message.channel] },
    { emoji: "👀", execute: (text) => console.log(text), imports: ["This text will be printed to the console."] }
    /* etc.. */
], 60000); // Collector running time in ms
```

**And so, let's now tell you in detail what is responsible for what.**

* `emoji` - Emoji that will be placed and perform your further action.

* `execute` - The function that will execute when you click on your 'custom' reaction.

* `imports` - Required parameters to run the function. They must be in an array or you will get an error. For example, in the `execute` parameter you want something to be displayed in the console. We indicate callback in `execute` example `text` and in the imports we include our text `["Hello bro"]`


## 🎉 Events
You can control user actions using our events.
```js
let page = new Pages(message.author.id);

page.on("create", (data) => console.log(data))
```

**Available events:**

* `create` - Returns an object with message and collector content

* `add` - Returns a string (or writing). Fires when using the `<page>.add()` function

* `update` - Will return the object on page refresh

* `select` - Returns an object containing the page you selected and its content.

* `end` - Returns `true` if everything worked successfully

---
_Source: https://npm.io/package/gamemax.paginator · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._