Class BotKeyboardBuilder

constructor

• new BotKeyboardBuilder(maxRowWidth?: number | null): BotKeyboardBuilder

  Parameters

  • maxRowWidth: number | null = 3

  Returns BotKeyboardBuilder

ReadonlymaxRowWidth

append

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

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

  Parameters

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

    Button to add

  • force: boolean = false

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

  Returns this

asInline

• asInline(): InlineKeyboardMarkup

  Return contents of this builder as an inline keyboard

  Returns InlineKeyboardMarkup

asReply

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

  Return contents of this builder as a reply keyboard

  Parameters

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

  Returns ReplyKeyboardMarkup

push

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

  Add buttons, wrapping them once maxRowWidth is reached

  Parameters

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

    Buttons to add

  Returns this

row

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

  Add a row of buttons. Will not be wrapped.

  Parameters

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

    Row or a function that will populate it

  Returns this