telegraf-pagination
A simplified Telegraf plugin to provide users with a great interface.
Getting started
Prerequisites
You need to have telegraf installed on your project to use that plugin.
$ npm install telegraf
or
$ yarn add telegraf
See offical guide for more info. Once you have installed telegraf in your project, you can use telegraf-pagination.
Installing
Run one of these commands depending on what package manager you're using:
$ npm install telegraf-pagination
or
$ yarn add telegraf-pagination
Quick start
Default mode
const { Pagination } = require('telegraf-pagination');
let data = [...]; // define data as an array
bot.start(async ctx => {
let pagination = new Pagination({ data });
let text = await pagination.text();
let keyboard = await pagination.keyboard();
ctx.reply(text, keyboard);
pagination.handleActions(bot);
});
Lazy mode
const { Pagination } = require('telegraf-pagination');
let data = [...]; // define data as an array
bot.start(async ctx => {
let pagination = new Pagination({
lazy: true, // switch lazy mode on
data: (page, size) => data.slice((page-1)*size, page*size), // callback that returns items of the page. Can be asynchronous
total: data.length // optional. can be useful when generating a header
});
let text = await pagination.text();
let keyboard = await pagination.keyboard();
ctx.reply(text, keyboard);
pagination.handleActions(bot);
});
Full Example
const { Telegraf } = require("telegraf");
const { Pagination } = require("telegraf-pagination");
const TOKEN = "YOUR_BOT_TOKEN";
const bot = new Telegraf(TOKEN);
let fakeData = Array(10)
.fill(0)
.map((_, i) => ({
id: i,
title: `Item ${i + 1}`,
}));
bot.command("pagination", (ctx) => {
const pagination = new Pagination({
data: fakeData, // array of items
header: (currentPage, pageSize, total) =>
`${currentPage}-page of total ${total}`, // optional. Default value: 👇
// `Items ${(currentPage - 1) * pageSize + 1 }-${currentPage * pageSize <= total ? currentPage * pageSize : total} of ${total}`;
format: (item, index) => `${index + 1}. ${item.title}`, // optional. Default value: 👇
// `${index + 1}. ${item}`;
pageSize: 8, // optional. Default value: 10
rowSize: 4, // optional. Default value: 5 (maximum 8)
onSelect: (item, index) => {
ctx.reply(item.title);
}, // optional. Default value: empty function
messages: {
// optional
firstPage: "First page", // optional. Default value: "❗️ That's the first page"
lastPage: "Last page", // optional. Default value: "❗️ That's the last page"
prev: "◀️", // optional. Default value: "⬅️"
next: "▶️", // optional. Default value: "➡️"
delete: "🗑", // optional. Default value: "❌"
},
});
pagination.handleActions(bot); // pass bot or scene instance as a parameter
let text = await pagination.text(); // get pagination text
let keyboard = await pagination.keyboard(); // get pagination keyboard
ctx.replyWithHTML(text, keyboard);
});
bot.launch().then(() => {
console.log("Bot is running");
});
Contributing
Please read CODE_OF_CONDUCT.md for details on our code of conduct. Feel free to submit any pull request.
Versioning
We use SemVer for versioning. For the versions available, see the tags on this repository.
Authors
- Alisher Ortiqov - Initial work - mcpebloker
See also the list of contributors who participated in this project.
License
This project is licensed under the MIT License - see the LICENSE.md file for details
Please tell me how to use the stage. If I use return await ctx.wizard.next() , then the next scene starts with the ${callback-data}-next callback. If you remove ctx.wizard.next() at all, then the next scene simply does not start
14 Oct 25, 2022
0 Jun 14, 2022
3 Aug 29, 2022
33 Dec 23, 2022
148 Dec 26, 2022
34 Nov 30, 2021
3 Sep 28, 2021
55 Dec 24, 2022
12 Dec 21, 2022
137 Jan 1, 2023
6 Dec 9, 2021
15 Dec 22, 2022
11 Oct 4, 2022
3 Feb 5, 2022
30 Jan 6, 2023
7 Feb 26, 2022
13 May 31, 2022
4 Apr 11, 2022
13 Sep 7, 2022