Class BotKeyboardBuilder<Button>

constructor

• new BotKeyboardBuilder<
      Button extends InputBotKeyboardButton = InputInlineKeyboardButton,
  >(
      maxRowWidth?: number | null,
  ): BotKeyboardBuilder<Button>

  Type Parameters

  • Button extends InputBotKeyboardButton = InputInlineKeyboardButton

  Parameters

  • maxRowWidth: number | null = 3

  Returns BotKeyboardBuilder<Button>

ReadonlymaxRowWidth

append

• append(
      btn: ButtonLike<Button> | (() => ButtonLike<Button>),
      force?: boolean,
  ): this

  Append a button to the last row, wrapping if needed.

  Parameters

  • btn: ButtonLike<Button> | (() => ButtonLike<Button>)

    Button to add

  • force: boolean = false

    Whether to forcefully add the button (i.e. do not wrap)

  Returns this

asInline

• asInline(
      this: BotKeyboardBuilder<InputInlineKeyboardButton>,
      params?: Omit<InlineKeyboardMarkup, "type" | "buttons">,
  ): InlineKeyboardMarkup

  Return contents of this builder as an inline keyboard

  Parameters

  • this: BotKeyboardBuilder<InputInlineKeyboardButton>
  • params: Omit<InlineKeyboardMarkup, "type" | "buttons"> = {}

  Returns InlineKeyboardMarkup

asReply

• asReply(
      this: BotKeyboardBuilder<InputReplyKeyboardButton>,
      params?: Omit<ReplyKeyboardMarkup, "type" | "buttons">,
  ): ReplyKeyboardMarkup

  Return contents of this builder as a reply keyboard

  Parameters

  • this: BotKeyboardBuilder<InputReplyKeyboardButton>
  • params: Omit<ReplyKeyboardMarkup, "type" | "buttons"> = {}

  Returns ReplyKeyboardMarkup

push

• push(...buttons: (ButtonLike<Button> | (() => ButtonLike<Button>))[]): this

  Add buttons, wrapping them once maxRowWidth is reached

  Parameters

  • ...buttons: (ButtonLike<Button> | (() => ButtonLike<Button>))[]

    Buttons to add

  Returns this

row

• row(row: ButtonLike<Button>[] | ((arr: ButtonLike<Button>[]) => void)): this

  Add a row of buttons. Will not be wrapped.

  Parameters

  • row: ButtonLike<Button>[] | ((arr: ButtonLike<Button>[]) => void)

    Row or a function that will populate it

  Returns this