Aiogram markups

THIS PACKAGE REQUIRES LEGACY AIOGRAM

DO NOT USE IT IN PRODUCTION

This package helps you construct and use inline or text markups.

Simple usage

Let's start with example

from aiogram_markups import Markup, Button

class MainMenu(Markup):
    settings = Button('Settings')
    help = Button('Help')

So, you can construct your markups by class, inhered from Markup. But how you can use it? You can get full markup and set handler on any button in your menu. Example:

bot = Bot(TOKEN)
dp = Dispatcher(bot)


@dp.message_handler(commands=['start'])
async def start_handler(message):
    await message.answer(
        "Hi, im message with keyboard powered on aiogram_markups",
        reply_markup=MainMenu.get_markup()
    )


@dp.message_handler(MainMenu.settings.filter())
async def settings_handler(message):
    await message.answer("I know that you press on settings button!")

Note: You can create button aliases. it means that button will be have same functional, only names were different. To create an alias, use func button.alias(...)

If you need in inline keyboard markup, not text, all that you need: instead method get_markup, use method get_inline_markup, no changes in filter usage.

But you can ask, what is callback data of the button callback query? Callback data creating from prefix and MD5 text hash. Default prefix is ::keyboard:: (in Button.CALLBACK_ROOT), and I not recommend changing it. But if you change, one condition: it must end on colon.

How you can set up module middleware to void all functional, let's look in following code:

from aiogram_markups import setup_aiogram_keyboards


setup_aiogram_keyboards(dp)

What I did? I'm set up specify middleware, that skip states if sent text or callback found in any button pattern.

Note: You can configure if button call raise state skip. Just give to button argument ignore_state to initialization method. Also you can set default call answer on button in argument on_call.

Data keyboards

You can make keyboards with need data in buttons. Look at the following example:

class DataKeyboardEx(Markup):
    __ignore_state__ = False
    
    hour = Button('Hour', data='h')
    minute = Button('Minute', data='m')
    second = Button('Second', data='s')

So, you can same get inline or keyboard markup. If markup inline, data were in call.data, if text markup, in message.text. Field __ignore_state__ is default value of ignore_state for all buttons in keyboard. In data keyboards, if you use states, it must be set to False.

Note: you can make fully messages from keyboards. Just write into field __text__ message text and call method Markup.process. But this feature design is not thought out enough.

Inheritance

You can merge two keyboards via inherit. For example, you can have one undo keyboard and many data keyboards, and you don't need to assign undo button every time, use following feature:

from aiogram_markups import Orientation


class CancelKeyboard(Markup):
    __orientation__ = Orientation.BOTTOM
    
    cancel = Button('Cancel')


class DataKeyboardEx(CancelKeyboard):
    __ignore_state__ = False
    
    hour = Button('Hour', data='h')
    minute = Button('Minute', data='m')
    second = Button('Second', data='s')

In code above, field __orientation__ with value Orientation.BOTTOM means that this keyboard must be at the bottom if join to another. But this param you can set to any button, Markup.__orientation__ field just sets default value.

Note: you can fast bind your keyboards/buttons, use method bind or operator >>. For example: CancelKeyboard.cancel >> MainMenuKeyboard, binds that cancel button must process MainMenuKeyboard.