Reply Keyboards¶

Reply keyboards are shown at the bottom of the chat interface and allow users to send predefined responses by tapping buttons.

Basic Usage¶

from pykeyboard import ReplyKeyboard, ReplyButton

# Create a simple reply keyboard
keyboard = ReplyKeyboard()
keyboard.add(
    ReplyButton("Yes"),
    ReplyButton("No"),
    ReplyButton("Maybe")
)

# Use with your bot
await message.reply_text("What do you think?", reply_markup=keyboard)

Parameters¶

row_width (int, default 3): Number of buttons per row
resize_keyboard (bool, optional): Whether to resize keyboard to fit content
one_time_keyboard (bool, optional): Whether keyboard disappears after one use
selective (bool, optional): Whether keyboard is shown only to specific users
placeholder (str, optional): Placeholder text shown in input field

Advanced Features¶

Contact and Location Requests¶

keyboard = ReplyKeyboard(resize_keyboard=True)
keyboard.row(
    ReplyButton("📱 Share Contact", request_contact=True),
    ReplyButton("📍 Share Location", request_location=True)
)
keyboard.row(ReplyButton("❌ Cancel"))

Poll Creation¶

keyboard = ReplyKeyboard()
keyboard.add(
    ReplyButton("📊 Create Quiz", request_poll=KeyboardButtonPollType(type="quiz")),
    ReplyButton("📈 Create Poll", request_poll=KeyboardButtonPollType(type="regular"))
)

User and Chat Selection¶

from pyrogram.types import KeyboardButtonRequestUsers, KeyboardButtonRequestChat

keyboard = ReplyKeyboard()
keyboard.add(
    ReplyButton("👤 Select User", request_users=KeyboardButtonRequestUsers(request_id=1)),
    ReplyButton("👥 Select Chat", request_chat=KeyboardButtonRequestChat(request_id=2))
)

Web App Integration¶

from pyrogram.types import WebAppInfo

keyboard = ReplyKeyboard()
keyboard.add(
    ReplyButton("🌐 Open Web App", web_app=WebAppInfo(url="https://example.com"))
)

Layout Control¶

Row-based Layout¶

keyboard = ReplyKeyboard()
keyboard.row(ReplyButton("Top Button"))
keyboard.row(
    ReplyButton("Left"),
    ReplyButton("Right")
)
keyboard.row(ReplyButton("Bottom Button"))

Automatic Layout¶

keyboard = ReplyKeyboard(row_width=2)
keyboard.add(
    ReplyButton("Button 1"),
    ReplyButton("Button 2"),
    ReplyButton("Button 3"),
    ReplyButton("Button 4"),
    ReplyButton("Button 5")  # Will be on its own row
)

Keyboard Types¶

One-time Keyboard¶

keyboard = ReplyKeyboard(
    one_time_keyboard=True,
    placeholder="Choose an option..."
)
keyboard.add(ReplyButton("Option 1"), ReplyButton("Option 2"))

Resizable Keyboard¶

keyboard = ReplyKeyboard(resize_keyboard=True)
keyboard.add(ReplyButton("Small Button"))

Selective Keyboard¶

keyboard = ReplyKeyboard(selective=True)
keyboard.add(ReplyButton("For You Only"))

Integration Examples¶

Complete Bot Example¶

from pyrogram import Client, filters
from pykeyboard import ReplyKeyboard, ReplyButton

app = Client("my_bot")

# Main menu keyboard
main_menu = ReplyKeyboard(resize_keyboard=True, one_time_keyboard=True)
main_menu.add(
    ReplyButton("📋 Tasks"),
    ReplyButton("📊 Statistics"),
    ReplyButton("⚙️ Settings")
)

# Settings keyboard
settings_menu = ReplyKeyboard(resize_keyboard=True)
settings_menu.row(
    ReplyButton("🔔 Notifications"),
    ReplyButton("🌐 Language")
)
settings_menu.row(ReplyButton("⬅️ Back"))

@app.on_message(filters.command("start"))
async def start_command(client, message):
    await message.reply_text(
        "Welcome! Choose an option:",
        reply_markup=main_menu
    )

@app.on_message(filters.text & filters.regex("Settings"))
async def settings_handler(client, message):
    await message.reply_text(
        "Settings:",
        reply_markup=settings_menu
    )

app.run()

Contact Collection¶

contact_keyboard = ReplyKeyboard(resize_keyboard=True)
contact_keyboard.row(
    ReplyButton("📱 Share Contact", request_contact=True)
)
contact_keyboard.row(ReplyButton("Skip"))

@app.on_message(filters.contact)
async def contact_handler(client, message):
    contact = message.contact
    await message.reply_text(f"Thanks! Phone: {contact.phone_number}")

@app.on_message(filters.text & filters.regex("Share Contact"))
async def request_contact(client, message):
    await message.reply_text(
        "Please share your contact:",
        reply_markup=contact_keyboard
    )

Best Practices¶

Use appropriate keyboard types: One-time keyboards for menus, persistent for ongoing interactions
Keep it simple: Don't overload users with too many options
Use emojis: They make buttons more recognizable
Handle all responses: Make sure your bot can handle all possible button presses
Consider mobile: Test on mobile devices as button layout may differ

Error Handling¶

try:
    keyboard = ReplyKeyboard(row_width=0)  # Invalid
except ValueError as e:
    print(f"Keyboard error: {e}")

# Always check if keyboard was created successfully
if keyboard:
    await message.reply_text("Choose:", reply_markup=keyboard)