Inline Keyboards¶

from pykeyboard import InlineKeyboard, InlineButton

# Create keyboard
keyboard = InlineKeyboard()

# Add buttons
keyboard.add(
    InlineButton("Option 1", "choice:1"),
    InlineButton("Option 2", "choice:2"),
    InlineButton("Cancel", "action:cancel")
)

# Send to user
await message.reply_text("Choose an option:", reply_markup=keyboard)

InlineButton("Click me", "callback_data")

InlineButton("Visit Website", url="https://example.com")

from pyrogram.types import WebAppInfo

button = InlineButton("Open Web App", web_app=WebAppInfo(url="https://myapp.com"))

from pyrogram.types import LoginUrl

button = InlineButton("Login", login_url=LoginUrl(url="https://example.com/login"))

# 2 buttons per row
keyboard = InlineKeyboard(row_width=2)
keyboard.add("A", "B", "C", "D")  # Creates 2 rows: [A,B], [C,D]

keyboard = InlineKeyboard()
keyboard.row("Button 1", "Button 2")  # First row
keyboard.row("Button 3")              # Second row
keyboard.add("Button 4", "Button 5")  # Third row (auto-layout)

keyboard = InlineKeyboard()
keyboard.paginate(
    count_pages=25,
    current_page=12,
    callback_pattern="page:{number}"
)
# Creates: « 1 ‹ 11 · 12 · 13 › 25 »

keyboard = InlineKeyboard()
keyboard.paginate(3, 2, 'pagination:{number}')

keyboard = InlineKeyboard()
keyboard.paginate(5, 3, 'pagination:{number}')

keyboard = InlineKeyboard()
keyboard.paginate(9, 5, 'pagination:{number}')

keyboard = InlineKeyboard()
keyboard.paginate(100, 50, 'page:{number}')

keyboard = InlineKeyboard()
keyboard.paginate(150, 75, 'page:{number}')
keyboard.row(
    InlineButton('🔙 Back', 'action:back'),
    InlineButton('❌ Close', 'action:close')
)

keyboard = InlineKeyboard()
keyboard.languages(
    callback_pattern="lang:{locale}",
    locales=["en_US", "es_ES", "fr_FR", "de_DE"],
    row_width=2
)

from pykeyboard import KeyboardBuilder

builder = KeyboardBuilder(InlineKeyboard())
keyboard = (builder
    .add_button("Yes", "yes")
    .add_button("No", "no")
    .add_row("Maybe", "Cancel")
    .build())

# Good: Structured callback data
InlineButton("Edit", "action:edit:item:123")

# Bad: Unstructured data
InlineButton("Edit", "edit_item_123")

from pykeyboard import PaginationUnchangedError

try:
    await callback_query.edit_message_text("Updated!")
except PaginationUnchangedError as e:
    # Handle MessageNotModifiedError, etc.
    await callback_query.answer("Already updated")

from pykeyboard import KeyboardFactory

keyboard = KeyboardFactory.create_confirmation_keyboard(
    yes_text="✅ Confirm",
    no_text="❌ Cancel",
    callback_pattern="confirm:{action}"
)

def create_menu(items, callback_prefix):
    keyboard = InlineKeyboard(row_width=2)
    for item in items:
        keyboard.add(InlineButton(item['name'], f"{callback_prefix}:{item['id']}"))
    return keyboard

@app.on_callback_query(filters.regex(r"counter:(\w+)"))
async def handle_counter(client, callback_query):
    action = callback_query.matches[0].group(1)

    # Update counter in database
    new_count = update_counter(action)

    # Update keyboard with new data
    keyboard = create_counter_keyboard(new_count)
    await callback_query.edit_message_reply_markup(keyboard)

keyboard.paginate(5, 1, "page:{number}", "user_123")  # Safe to call multiple times

# Always answer callbacks quickly
await callback_query.answer()  # Answer immediately

# Then do heavy processing
await do_heavy_work()

# Finally update message
await callback_query.edit_message_text("Done!")