Class Menu

constructor

• new Menu(id: string): Menu

  Constructs a new Menu instance.

  Parameters

  • id: string

    Unique string identifier for the menu.

  Returns Menu

Readonlyid

Optionalparent

back

• back(label?: MenuLabel, onNavigate?: MenuNavigationHandler): this

  Appends a back button that returns to the parent menu.

  Parameters

  • label: MenuLabel = "Back"

    Button label text (default: "Back").

  • OptionalonNavigate: MenuNavigationHandler

    Optional callback hook executed before navigating back.

  Returns this

  This Menu instance for chaining.

  Example

  subMenu.back("Go Back");
  Copy

build

• build(
      ctx?: CallbackContext<
          Record<string, unknown>,
          Record<string, unknown>,
          Record<string, unknown>,
      >,
  ): InlineKeyboardMarkup

  Synchronously builds the InlineKeyboardMarkup for this menu.

  Parameters

  • Optionalctx: CallbackContext<
        Record<string, unknown>,
        Record<string, unknown>,
        Record<string, unknown>,
    >

    Optional CallbackContext for dynamic label resolution.

  Returns InlineKeyboardMarkup

  Constructed inline keyboard markup.

  Example

  await ctx.reply("Choose an option:", {
    reply_markup: menu.build(ctx),
  });
  Copy

findMenu

• findMenu(menuId: string, visited?: Set<Menu>): Menu | undefined

  Finds a menu instance by its identifier anywhere in this menu's hierarchy.

  Parameters

  • menuId: string

    Identifier of the menu to locate.

  • visited: Set<Menu> = ...

    Internal set of visited menus to avoid cycles.

  Returns Menu | undefined

  The matching Menu instance or undefined.

middleware

• middleware(): MiddlewareFn

  Creates a MiddlewareFn that automatically intercepts matching callback queries, dispatches button handlers, and performs in-place menu navigation.

  Returns MiddlewareFn

  A middleware function for use with app.use().

render

• render(
      ctx?: CallbackContext<
          Record<string, unknown>,
          Record<string, unknown>,
          Record<string, unknown>,
      >,
  ): Promise<InlineKeyboardMarkup>

  Asynchronously renders the InlineKeyboardMarkup, resolving any async dynamic labels.

  Parameters

  • Optionalctx: CallbackContext<
        Record<string, unknown>,
        Record<string, unknown>,
        Record<string, unknown>,
    >

    Optional CallbackContext for dynamic label evaluation.

  Returns Promise<InlineKeyboardMarkup>

  Resolves with the constructed InlineKeyboardMarkup.

row

• row(): this

  Advances the menu builder to start a new row of buttons.

  Returns this

  This Menu instance for chaining.

submenu

• submenu(
      label: MenuLabel,
      targetMenu: Menu,
      onNavigate?: MenuNavigationHandler,
  ): this

  Appends a navigation button leading to a child Menu.

  Parameters

  • label: MenuLabel

    Static string label or dynamic label function.

  • targetMenu: Menu

    The destination submenu to open.

  • OptionalonNavigate: MenuNavigationHandler

    Optional callback hook executed before switching menus.

  Returns this

  This Menu instance for chaining.

  Example

  menu.submenu("Preferences", preferencesMenu);
  Copy

text

• text(label: MenuLabel, handler: MenuButtonHandler): this

  Appends an interactive callback button with a click handler to the current row.

  Parameters

  • label: MenuLabel

    Static string label or dynamic label function.

  • handler: MenuButtonHandler

    Callback function executed when the button is clicked.

  Returns this

  This Menu instance for chaining.

  Example

  menu.text("Click Me", async (ctx) => {
    await ctx.reply("Button clicked!");
  });
  Copy

url

• url(label: MenuLabel, url: string): this

  Appends an external URL button to the current row.

  Parameters

  • label: MenuLabel

    Static string label or dynamic label function.

  • url: string

    HTTP or tg:// URL opened when the button is clicked.

  Returns this

  This Menu instance for chaining.