https://github.com/VDS13/telegram-inline-calendar

Date and time picker and Inline calendar for Node.js telegram bots
https://github.com/VDS13/telegram-inline-calendar

calendar grammy inline-keyboard node-telegram-bot-api telebot telegraf telegram telegram-bot time time-selector

Last synced: about 23 hours ago
JSON representation

Date and time picker and Inline calendar for Node.js telegram bots

Host: GitHub
URL: https://github.com/VDS13/telegram-inline-calendar
Owner: VDS13
License: mit
Created: 2022-12-20T10:27:22.000Z (over 2 years ago)
Default Branch: main
Last Pushed: 2025-03-26T12:53:47.000Z (about 2 months ago)
Last Synced: 2025-04-30T11:07:25.878Z (12 days ago)
Topics: calendar, grammy, inline-keyboard, node-telegram-bot-api, telebot, telegraf, telegram, telegram-bot, time, time-selector
Language: JavaScript
Homepage:
Size: 35.1 MB
Stars: 98
Watchers: 1
Forks: 19
Open Issues: 1
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

awesome-grammY - VDS13/telegram-inline-calendar - Date picker and inline calendar for your bots. (Plugins)

README

        
telegram-inline-calendar




Date and time picker and inline calendar for Node.js telegram bots.

[![Bot API](https://img.shields.io/badge/Bot%20API-v.6.3-00aced.svg?style=flat-square&logo=telegram)](https://core.telegram.org/bots/api)

[![npm package](https://img.shields.io/npm/v/telegram-inline-calendar?logo=npm&style=flat-square)](https://www.npmjs.org/package/telegram-inline-calendar)

[![npm download](https://img.shields.io/npm/dt/telegram-inline-calendar)](https://www.npmjs.org/package/telegram-inline-calendar)



## 📙 Description

Using this simple inline calendar you can allow your Telegram bot to ask dates.



Supported languages:

* English

* French

* Russian

* Spanish

* Italian

* German

* Turkish

* Indonesian

* Ukrainian

* Brazilian Portuguese (pt-br)

Supported Telegram bot libraries:

* [Telegraf](https://github.com/telegraf/telegraf)

* [node-telegram-bot-api](https://github.com/yagop/node-telegram-bot-api)

* [telebot](https://github.com/mullwar/telebot)

* [grammY](https://github.com/grammyjs/grammY)

## 📦 Install

There are two versions:

### v1.x - if you are using CommonJS modules

```sh

npm i telegram-inline-calendar

```

### v2.x - if you are using ES modules

```sh

npm i telegram-inline-calendar@ecmascript

```

> ✍️ **Note:** If you use Typescript you can install this package that contains type definitions for this library

>```sh

>npm install --save-dev telegram-inline-calendar-types

>```

## 🎚️ Changelog ([v1.x](https://github.com/VDS13/telegram-inline-calendar/blob/main/v1.x/CHANGELOG.md) or [v2.x](https://github.com/VDS13/telegram-inline-calendar/blob/main/v2.x/CHANGELOG.md))

## 🗺 API ([v1.x](https://github.com/VDS13/telegram-inline-calendar/blob/main/v1.x/API.md) or [v2.x](https://github.com/VDS13/telegram-inline-calendar/blob/main/v2.x/API.md))

## 🖥️ Examples ([v1.x](https://github.com/VDS13/telegram-inline-calendar/blob/main/v1.x/EXAMPLES.md) or [v2.x](https://github.com/VDS13/telegram-inline-calendar/blob/main/v2.x/EXAMPLES.md))

## 🚀 Usage

### node-telegram-bot-api

#### CommonJS

```js

const TOKEN = process.env.TELEGRAM_TOKEN || 'YOUR_TELEGRAM_BOT_TOKEN';

const TelegramBot = require('node-telegram-bot-api');

const Calendar = require('telegram-inline-calendar');

process.env.NTBA_FIX_319 = 1;

const bot = new TelegramBot(TOKEN, {polling: true});

const calendar = new Calendar(bot, {

    date_format: 'DD-MM-YYYY',

    language: 'en'

});

bot.onText(/\/start/, (msg) => calendar.startNavCalendar(msg));

bot.on("callback_query", (query) => {

    if (query.message.message_id == calendar.chats.get(query.message.chat.id)) {

        res = calendar.clickButtonCalendar(query);

        if (res !== -1) {

            bot.sendMessage(query.message.chat.id, "You selected: " + res);

        }

    }

});

```

#### ESM

```js

const TOKEN = process.env.TELEGRAM_TOKEN || 'YOUR_TELEGRAM_BOT_TOKEN';

import TelegramBot from 'node-telegram-bot-api';

import {Calendar} from 'telegram-inline-calendar';

process.env.NTBA_FIX_319 = 1;

const bot = new TelegramBot(TOKEN, {polling: true});

const calendar = new Calendar(bot, {

    date_format: 'DD-MM-YYYY',

    language: 'en'

});

bot.onText(/\/start/, (msg) => calendar.startNavCalendar(msg));

bot.on("callback_query", (query) => {

    if (query.message.message_id == calendar.chats.get(query.message.chat.id)) {

        var res;

        res = calendar.clickButtonCalendar(query);

        if (res !== -1) {

            bot.sendMessage(query.message.chat.id, "You selected: " + res);

        }

    }

});

```

### telegraf

#### CommonJS

```js

const TOKEN = process.env.TELEGRAM_TOKEN || 'YOUR_TELEGRAM_BOT_TOKEN';

const {Telegraf} = require('telegraf');

const Calendar = require('telegram-inline-calendar');

const bot = new Telegraf(TOKEN);

const calendar = new Calendar(bot, {

    date_format: 'DD-MM-YYYY',

    language: 'en',

    bot_api: 'telegraf'

});

bot.start((ctx) => calendar.startNavCalendar(ctx.message));

bot.on("callback_query", (ctx) => {

    if (ctx.callbackQuery.message.message_id == calendar.chats.get(ctx.callbackQuery.message.chat.id)) {

        res = calendar.clickButtonCalendar(ctx.callbackQuery);

        if (res !== -1) {

            bot.telegram.sendMessage(ctx.callbackQuery.message.chat.id, "You selected: " + res);

        }

    }

});

bot.launch();

process.once('SIGINT', () => bot.stop('SIGINT'));

process.once('SIGTERM', () => bot.stop('SIGTERM'));

```

#### ESM

```js

const TOKEN = process.env.TELEGRAM_TOKEN || 'YOUR_TELEGRAM_BOT_TOKEN';

import {Telegraf} from 'telegraf';

import {Calendar} from 'telegram-inline-calendar';

const bot = new Telegraf(TOKEN, {polling: true});

const calendar = new Calendar(bot, {

    date_format: 'DD-MM-YYYY',

    language: 'en',

    bot_api: 'telegraf'

});

bot.start((ctx) => calendar.startNavCalendar(ctx));

bot.on("callback_query", (ctx) => {

    if (ctx.callbackQuery.message.message_id == calendar.chats.get(ctx.callbackQuery.message.chat.id)) {

        var res;

        res = calendar.clickButtonCalendar(ctx);

        if (res !== -1) {

            ctx.reply("You selected: " + res);

        }

    }

});

bot.launch();

process.once('SIGINT', () => bot.stop('SIGINT'));

process.once('SIGTERM', () => bot.stop('SIGTERM'));

```

### telebot

#### CommonJS

```js

const TOKEN = process.env.TELEGRAM_TOKEN || 'YOUR_TELEGRAM_BOT_TOKEN';

const Telebot = require('telebot');

const Calendar = require('telegram-inline-calendar');

const bot = new Telebot(TOKEN);

const calendar = new Calendar(bot, {

    date_format: 'DD-MM-YYYY',

    language: 'en',

    bot_api: 'telebot'

});

bot.on('/start', (msg) => calendar.startNavCalendar(msg));

bot.on("callbackQuery", (query) => {

    if (query.message.message_id == calendar.chats.get(query.message.chat.id)) {

        res = calendar.clickButtonCalendar(query);

        if (res !== -1) {

            bot.sendMessage(query.message.chat.id, "You selected: " + res);

        }

    }

});

bot.connect();

```

#### ESM

```js

const TOKEN = process.env.TELEGRAM_TOKEN || 'YOUR_TELEGRAM_BOT_TOKEN';

import Telebot from 'telebot';

import {Calendar} from 'telegram-inline-calendar';

const bot = new Telebot(TOKEN, {polling: true});

const calendar = new Calendar(bot, {

    date_format: 'DD-MM-YYYY',

    language: 'en',

    bot_api: 'telebot'

});

bot.on('/start', (msg) => calendar.startNavCalendar(msg));

bot.on("callbackQuery", (query) => {

    if (query.message.message_id == calendar.chats.get(query.message.chat.id)) {

        var res;

        res = calendar.clickButtonCalendar(query);

        if (res !== -1) {

            bot.sendMessage(query.message.chat.id, "You selected: " + res);

        }

    }

});

bot.connect();

```

### grammY

#### CommonJS

```js

const TOKEN = process.env.TELEGRAM_TOKEN || 'YOUR_TELEGRAM_BOT_TOKEN';

const { Bot } = require('grammy');

const Calendar = require('telegram-inline-calendar');

const bot = new Bot(TOKEN);

const calendar = new Calendar(bot, {

    date_format: 'DD-MM-YYYY',

    language: 'en',

    bot_api: 'grammy'

});

bot.command('start', ctx => calendar.startNavCalendar(ctx.msg))

bot.on("callback_query:data", async (ctx) => {

    if (ctx.msg.message_id === calendar.chats.get(ctx.chat.id)) {

        res = calendar.clickButtonCalendar(ctx.callbackQuery);

        if (res !== -1) {

            await ctx.reply("You selected: " + res);

        }

    }

});

bot.start();

```

#### ESM

```js

const TOKEN = process.env.TELEGRAM_TOKEN || 'YOUR_TELEGRAM_BOT_TOKEN';

import { Bot } from 'grammy';

import {Calendar} from 'telegram-inline-calendar';

const bot = new Bot(TOKEN, {polling: true});

const calendar = new Calendar(bot, {

    date_format: 'DD-MM-YYYY',

    language: 'en',

    bot_api: 'grammy'

});

bot.command('start', ctx => calendar.startNavCalendar(ctx))

bot.on("callback_query:data", (ctx) => {

    if (ctx.msg.message_id == calendar.chats.get(ctx.chat.id)) {

        var res;

        res = calendar.clickButtonCalendar(ctx);

        if (res !== -1) {

            ctx.reply("You selected: " + res);

        }

    }

});

bot.start();

```

## ⚙️ Default options

```javascript

{

    date_format: 'YYYY-MM-DD',                     //Datetime result format

    language: 'en',                                //Language (en/es/de/es/fr/it/tr/id/uk/pt-br)

    bot_api: 'node-telegram-bot-api',              //Telegram bot library

    close_calendar: true,                          //Close calendar after date selection

    start_week_day: 0,                             //First day of the week(Sunday - `0`, Monday - `1`, Tuesday - `2` and so on)

    time_selector_mod: false,                      //Enable time selection after a date is selected.

    time_range: "00:00-23:59",                     //Allowed time range in "HH:mm-HH:mm" format

    time_step: "30m",                              //Time step in the format ""

    start_date: false,                             //Minimum date of the calendar in the format "YYYY-MM-DD" or "YYYY-MM-DD HH:mm" or "now"

    stop_date: false,                              //Maximum date of the calendar in the format "YYYY-MM-DD" or "YYYY-MM-DD HH:mm" or "now"

    custom_start_msg: false,                       //Text of the message sent with the calendar/time selector

    lock_date: false,                              //Enable blocked dates list

    lock_datetime: false,                          //Enable list of blocked dates and times

    user_lang_select: false,                       //Ability to select the user's language

    slip_years: false                              //Number of years to skip (1 < `skip_years` < 10)

}

```

## License

**The MIT License (MIT)**

Copyright © 2022-present Dmitry Vyazin

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/VDS13/telegram-inline-calendar

Awesome Lists containing this project

README

telegram-inline-calendar