https://github.com/go-telegram/ui

UI controls for Telegram Bot API go framework
https://github.com/go-telegram/ui

go telegram telegram-bot telegram-bot-api

Last synced: 5 months ago
JSON representation

UI controls for Telegram Bot API go framework

• Host: GitHub
• URL: https://github.com/go-telegram/ui
• Owner: go-telegram
• License: mit
• Created: 2022-04-10T19:48:50.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2025-05-06T18:30:22.000Z (about 1 year ago)
• Last Synced: 2025-05-06T19:41:03.667Z (about 1 year ago)
• Topics: go, telegram, telegram-bot, telegram-bot-api
• Language: Go
• Homepage:
• Size: 2.43 MB
• Stars: 177
• Watchers: 6
• Forks: 20
• Open Issues: 6
• Metadata Files:
  • Readme: readme.md
  • Changelog: changelog.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Go Telegram Bot UI

> The project is under development. API may be changed before v1.0.0 version.

> [Telegram Group](https://t.me/gotelegrambotui)

UI controls for telegram bot [go-telegram/bot](https://github.com/go-telegram/bot)

- datepicker

- inline keyboard

- reply keyboard

- paginator

- slider

- progress

- dialog

- timepicker (todo)

Feel to free to contribute and issues!

## Getting Started

```bash

go get github.com/go-telegram/bot

go get github.com/go-telegram/ui

```

**Important**

UI components register own bot handlers on init. 

If you restart the bot instance, inline buttons in already opened components can't work.

For solving this issue, you should use `bot.WithPrefix` option for instance of widgets.

Example:

```go

picker := datepicker.New(

    b, 

    onDatepickerSimpleSelect, 

    datepicker.WithPrefix("datepicker-simple"),

)

```

### Live demo

You can run demo bot from `examples` folder.

Before start, you should set `EXAMPLE_TELEGRAM_BOT_TOKEN` environment variable to your bot token.

```go

    go run examples/*.go

```

Also, you can try [online version of this bot](https://t.me/gotelegramuidemobot) right now.

## DatePicker

![datepicker_1.png](datepicker/datepicker.png)

- custom localizations

- define include/exclude dates

[Documentation](datepicker/readme.md)

## Inline Keyboard

![inline_keyboard.png](keyboard/inline/inline_keyboard.png)

Small helper for easy building of inline keyboard.

[Documentation](keyboard/inline/readme.md)

## Reply Keyboard

![reply_keyboard.png](keyboard/reply/reply_keyboard.png)

Small helper for easy building of a reply keyboard markup.

[Documentation](keyboard/reply/readme.md)

## Paginator

![paginator.png](paginator/paginator.png)

- pass any slice of strings

- set perPage value

- set custom lines separator

[Documentation](paginator/readme.md)

## Slider

![slider.png](slider/slider.png)

- pass slides with images and text

[Documentation](slider/readme.md)

## Progress

![progress.png](progress/progress.png)

Progress bar for long tasks

[Documentation](progress/readme.md)

## Dialog

![dialog.gif](dialog/dialog.gif)

Simple dialogs

[Documentation](dialog/readme.md)