python/aiogram
1
0
Fork 0
mirror of https://github.com/aiogram/aiogram.git synced 2025-12-12 10:11:52 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Enhance keyboard utility, improved documentation page. (#1236)

Browse source 
* Enhance keyboard utility, improved documentation for this utility.

Updated the 'aiogram/utils/keyboard.py' file with new methods for integrating buttons and keyboard creation more seamlessly. Added functionality to create buttons from existing markup and attach another builder. This improvement aims to make the keyboard building process more user-friendly and flexible.

* Added changelog

* Cover by tests
This commit is contained in:
Alex Root Junior 2023-08-04 22:36:50 +03:00 • committed by GitHub
parent 11dc7eaa31
commit 90654ac0fa
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 146 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

39
docs/utils/keyboard.rst
View file

@ -14,6 +14,8 @@ Keyboard builder helps to dynamically generate markup.
Usage example
=============
For example you want to generate inline keyboard with 10 buttons
.. code-block:: python
builder = InlineKeyboardBuilder()
@ -21,22 +23,45 @@ Usage example
for index in range(1, 11):
builder.button(text=f"Set {index}", callback_data=f"set:{index}")
then adjust this buttons to some grid, for example first line will have 3 buttons, the next lines will have 2 buttons
.. code-block::
builder.adjust(3, 2)
also you can attach another builder to this one
.. code-block:: python
another_builder = InlineKeyboardBuilder(...)... # Another builder with some buttons
builder.attach(another_builder)
or you can attach some already generated markup
.. code-block:: python
markup = InlineKeyboardMarkup(inline_keyboard=[...]) # Some markup
builder.attach(InlineKeyboardBuilder.from_markup(markup))
and finally you can export this markup to use it in your message
.. code-block:: python
await message.answer("Some text here", reply_markup=builder.as_markup())
Reply keyboard builder has the same interface
.. warning::
Note that you can't attach reply keyboard builder to inline keyboard builder and vice versa
Base builder
============
.. autoclass:: aiogram.utils.keyboard.ReplyKeyboardBuilder
:members: __init__, buttons, copy, export, add, row, adjust, button, as_markup
:undoc-members: True
Inline Keyboard
===============
.. autoclass:: aiogram.utils.keyboard.InlineKeyboardBuilder
:noindex:
:members: __init__, buttons, copy, export, add, row, adjust, from_markup, attach
.. method:: button(text: str, url: Optional[str] = None, login_url: Optional[LoginUrl] = None, callback_data: Optional[Union[str, CallbackData]] = None, switch_inline_query: Optional[str] = None, switch_inline_query_current_chat: Optional[str] = None, callback_game: Optional[CallbackGame] = None, pay: Optional[bool] = None, **kwargs: Any) -> aiogram.utils.keyboard.InlineKeyboardBuilder
:noindex:
@ -52,7 +77,7 @@ Reply Keyboard
==============
.. autoclass:: aiogram.utils.keyboard.ReplyKeyboardBuilder
:noindex:
:members: __init__, buttons, copy, export, add, row, adjust, from_markup, attach
.. method:: button(text: str, request_contact: Optional[bool] = None, request_location: Optional[bool] = None, request_poll: Optional[KeyboardButtonPollType] = None, **kwargs: Any) -> aiogram.utils.keyboard.ReplyKeyboardBuilder
:noindex: