Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/realpeha/telegram-keyboard
Simple and powerful keyboard builder for Telegram Bots
https://github.com/realpeha/telegram-keyboard
inline-keyboard keyboard keyboard-builder telegraf telegram-bot telegram-keyboard
Last synced: 5 days ago
JSON representation
Simple and powerful keyboard builder for Telegram Bots
- Host: GitHub
- URL: https://github.com/realpeha/telegram-keyboard
- Owner: RealPeha
- Created: 2019-05-30T21:18:17.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-08-30T05:03:13.000Z (5 months ago)
- Last Synced: 2025-01-06T04:04:22.299Z (12 days ago)
- Topics: inline-keyboard, keyboard, keyboard-builder, telegraf, telegram-bot, telegram-keyboard
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/telegram-keyboard
- Size: 207 KB
- Stars: 130
- Watchers: 4
- Forks: 12
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Telegram Keyboard Builder
Simple and powerful reply and inline keyboard builder for Telegram Bots
## Installation
Just use npm
npm i telegram-keyboard --save
or yarn
yarn add telegram-keyboard
## Example of use in Telegraf
```javascript
const Telegraf = require('telegraf')
const { Keyboard } = require('telegram-keyboard')
const bot = new Telegraf(process.env.BOT_TOKEN)
bot.on('text', async (ctx) => {
const keyboard = Keyboard.make([
['Button 1', 'Button 2'], // First row
['Button 3', 'Button 4'], // Second row
])
await ctx.reply('Simple built-in keyboard', keyboard.reply())
await ctx.reply('Simple inline keyboard', keyboard.inline())
})
```
## Reply (build-in) keyboard
#### Example
```javascript
const { Keyboard } = require('telegram-keyboard')
const keyboard = Keyboard.make(['Button 1', 'Button 2']).reply()
// or using shortcut
const keyboard = Keyboard.reply(['Button 1', 'Button 2'])
console.log(keyboard)
```
#### Result
```JSON
{
"reply_markup": {
"resize_keyboard": true,
"keyboard": [
[
"Button 1",
"Button 2"
]
]
}
}
```
## Inline keyboard
#### Example
```javascript
const { Keyboard } = require('telegram-keyboard')
const keyboard = Keyboard.make(['Button 1', 'Button 2']).inline()
// or using shortcut
const keyboard = Keyboard.inline(['Button 1', 'Button 2'])
console.log(keyboard)
```
#### Result
```JSON
{
"reply_markup": {
"resize_keyboard": true,
"inline_keyboard": [
[
{
"text": "Button 1",
"callback_data": "Button 1"
},
{
"text": "Button 2",
"callback_data": "Button 2"
}
]
]
}
}
```
## Inline keyboard with custom callback data
#### Example
```javascript
const { Keyboard, Key } = require('telegram-keyboard')
const keyboard = Keyboard.make([
Key.callback('Button 1', 'action1'),
Key.callback('Button 2', 'action2'),
]).inline()
console.log(keyboard)
```
#### Result
```JSON
{
"reply_markup": {
"resize_keyboard": true,
"inline_keyboard": [
[
{
"text": "Button 1",
"callback_data": "action1"
},
{
"text": "Button 2",
"callback_data": "action2"
}
]
]
}
}
```
## Fixed columns keyboard
#### Example
```javascript
const { Keyboard } = require('telegram-keyboard')
const keyboard = Keyboard.make(['1', '2', '3', '4', '5'], {
columns: 2,
}).reply()
console.log(keyboard)
```
#### Result
```JSON
{
"reply_markup": {
"resize_keyboard": true,
"keyboard": [
["1", "2"],
["3", "4"],
["5"]
]
}
}
```
## Calculated columns keyboard
#### Example
```javascript
const { Keyboard } = require('telegram-keyboard')
const keyboard = Keyboard.make(['1', '2', '3', '4', '5'], {
wrap: (row, index, button) => Math.random() > 0.5
}).reply()
console.log(keyboard)
```
#### Result
```JSON
{
"reply_markup": {
"resize_keyboard": true,
"keyboard": [ // different every time
["1", "2"],
["3"],
["4"],
["5"]
]
}
}
```
 
## Pattern
#### Example
In this example `pattern: [3, 1, 1]` means that the first row will have 3 buttons, the second - 1, the third - 1 and all the other buttons in the last row
```javascript
const { Keyboard } = require('telegram-keyboard')
const keyboard = Keyboard.make([1, 2, 3, 4, 5, 6, 7, 8, 9, 10], {
pattern: [3, 1, 1]
}).reply()
console.log(keyboard)
```
#### Result
```JSON
{
"reply_markup": {
"resize_keyboard": true,
"keyboard": [
["1", "2", "3"],
["4"],
["5"],
["6", "7", "8", "9", "10"]
]
}
}
```
## Custom filter function
Default filter function is `button => !button.hide` but you can pass your filtering function
#### Example
```javascript
const { Keyboard } = require('telegram-keyboard')
const keyboard = Keyboard.make([1, 2, 3, 4, 5, 6, 7, 8, 9, 10], {
columns: 2,
filter: btn => btn % 2
}).reply()
console.log(keyboard)
```
#### Result
```JSON
{
"reply_markup": {
"resize_keyboard": true,
"keyboard": [
["1", "3"],
["5", "7"],
["9"]
]
}
}
```
## Filter after build
#### Example
```javascript
const { Keyboard } = require('telegram-keyboard')
const keyboard = Keyboard.make([1, 2, 3, 4, 5, 6, 7, 8, 9, 10], {
columns: 2,
filter: btn => btn % 2,
filterAfterBuild: true
}).reply()
console.log(keyboard)
```
#### Result
```JSON
{
"reply_markup": {
"resize_keyboard": true,
"keyboard": [
["1"],
["3"],
["5"],
["7"],
["9"]
]
}
}
```
## Flat buttons
#### Example
```javascript
const { Keyboard } = require('telegram-keyboard')
const keyboard = Keyboard.make([[1, 2], [3, 4, 5, 6], [7, 8, 9, 10]], {
flat: true,
columns: 3,
}).reply()
console.log(keyboard)
```
#### Result
```JSON
{
"reply_markup": {
"resize_keyboard": true,
"keyboard": [
["1", "2", "3"],
["4", "5", "6"],
["7", "8", "9"],
[ "10"]
]
}
}
```
## Combine keyboards
#### Example
```javascript
const { Keyboard } = require('telegram-keyboard')
const keyboard1 = Keyboard.make(['1', '2', '3', '4'], {
columns: 2
})
const keyboard2 = Keyboard.make(['5', '6', '7', '8'])
const keyboard = Keyboard.combine(keyboard1, keyboard2).reply()
console.log(keyboard)
```
#### Result
```JSON
{
"reply_markup": {
"resize_keyboard": true,
"keyboard": [
["1", "2"],
["3", "4"],
["5", "6", "7", "8"]
]
}
}
```
## Construct keyboard
#### Example
Full example in [examples/pagination.js](https://github.com/RealPeha/telegram-keyboard/tree/master/examples/telegraf/pagination.js)
Instead of writing a separate function to create the keyboard like this:
```javascript
const createKeyboard = page => {
return Keyboard
.make(/* ... */)
}
```
You can pass function to Keyboard.make method. The function must return either an array of buttons or another keyboard.
After that with the keyboard.construct(someArgs) method you can recreate it
```javascript
const { Keyboard } = require('telegram-keyboard')
const items = [1, 2, 3, 4, 5, 6, 7, 8, 9, 10]
const itemsPerPage = 4
const keyboard = Keyboard.make((page) => {
const pageItems = items.slice(page * itemsPerPage, page * itemsPerPage + itemsPerPage)
return Keyboard.combine(
Keyboard.make(pageItems, { columns: 3 }),
Keyboard.make([
Key.callback('<----', 'left', page === 0),
Key.callback('---->', 'right', page === 2),
])
)
})
// remake keyboard with some other arguments
console.log(keyboard.construct(0).reply())
console.log(keyboard.construct(1).reply())
```
More examples you may find in [examples](https://github.com/RealPeha/telegram-keyboard/tree/master/examples)