Skip to content

RoutedMenu

class Tourmaline::RoutedMenu
inherits Reference #

The RoutedMenu helper class offers a simple to use DSL for creating menus, potentially with multiple levels. Includes support for HTTP like routing, route history, back buttons, and more.

Routes are hashed and shortened before being sent, which means you have no need to worry about the typical 65 character callback query data limit.

Example:

MENU = RoutedMenu.build do
  route "/" do
    content "Some content to go in the home route"
    buttons do
      route_button "Next page", "/page_2"
    end
  end

  route "/page_2" do
    content "..."
    buttons do
      back_button "Back"
    end
  end
end

# in a command
send_menu(chat_id, MENU)

Class methods#

.build(starting_route = "/" #

.hash_route(route : String) #

.new(routes = {} of String => Page, start_route = "/", group = Helpers.random_string(8)) #

Methods#

#add_route(route, page) #

#current_page #

#current_route : String #

#event_handler : EventHandler #

#handle_button_click(ctx) #

#route_history : Array(String) #

#routes : Hash(String, Page) #