# @ryukobot/paginationembed

> Easy array pagination in Discord.js v13

Latest version **1.0.5** (published 2021-10-05) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install @ryukobot/paginationembed
pnpm add @ryukobot/paginationembed
yarn add @ryukobot/paginationembed
bun add @ryukobot/paginationembed
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 1.0.5 |
| Published | 2021-10-05 |
| First published | 2021-09-17 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=16.6.0 |
| Dependencies | 0 |
| Unpacked size | 75.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Maintainers | jacany |
| Keywords | discord, discord-js, discord.js, bot, pagination, embed |

## Links

- npm: https://www.npmjs.com/package/@ryukobot/paginationembed
- Repository: https://github.com/ryukobot/paginationembed
- Issues: https://github.com/ryukobot/paginationembed/issues
- npm.io page: https://npm.io/package/@ryukobot/paginationembed

## Recent versions

- 1.0.5 (latest) — 2021-10-05
- 1.0.4 — 2021-09-27
- 1.0.3 — 2021-09-18
- 1.0.2 — 2021-09-18
- 1.0.1 — 2021-09-17
- 1.0.0 — 2021-09-17

## README

# paginationembed

An Easy and Stylish way of doing Discord Embed Pagination

[![CI](https://github.com/ryukobot/paginationembed/actions/workflows/ci.yml/badge.svg)](https://github.com/ryukobot/paginationembed/actions/workflows/ci.yml)

---

## Usage

```js
const { MessageEmbed } = require("discord.js");
const { MessagePagination } = require("@ryukobot/paginationembed");

const array = ["Element 1", "Element 2", "Element 3"];

const embed = new MessagePagination({
	embed: new MessageEmbed(),
	itemsPerPage: 2,
	startPage: 1,
	title: "Values",
	timeout: 300000, // Milliseconds before expiry
	message: Message, // Pass your Message Object
	array,
	callbackfn: (value, index) => `**${index + 1}.** ${value}`,
});

embed.build();
```

### Output
![Screenshot_20210917_142849](https://user-images.githubusercontent.com/30955604/133836832-501a6380-683f-4731-91a4-04c57a8f68d9.png)


## Installing

With NPM:

```sh
npm install @ryukobot/paginationembed
```

or Yarn:

```sh
yarn add @ryukobot/paginationembed
```

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