class

Tourmaline::PaginatedKeyboard

Inherits Reference < Object

Convenience class for creating an InlineKeyboard with built in pagination. It is designed to be customizable so as not to get in your way.

Constructors

new(client : Tourmaline::Client, results : Array(String) = [] of String, per_page : Int32 = 10, header : Nil | String = nil, footer : Nil | String = nil, prefix : Nil | String = nil, back_text : String = "Back", next_text : String = "Next", id : String = Helpers.random_string(8))

Creates a new PaginatedKeyboard

new(results = [] of String, per_page = 10, &block : self -> )

Creates a new PaginatedKeyboard, yielding the newly created keyboard to the block

Arguments

results - the initial set of results
per_page - the number of results to show on each page
header - text to be displayed above the results
footer - text to be displayed below the results
prefix - a string to be added to the beginning of each item
back_text - text to use for the back button
next_text - text to use for the next button
id - an id to be used both as the group name, and the prefix for the callback query data

Formatting

The params header, footer, and prefix are formatted prior to being injected into the message.

{page} - will be replaced with the current page number, starting at 1
{page count} - will be replaced with the total number of pages
{index} - for prefix only, gets replaced with the index of the current item, starting at 1

Instance methods

<<(*args, **options)

<<(*args, **options, &)

back_button_procs

back_button_procs=(back_button_procs : Array(Proc(PaginatedKeyboard, Nil)))

current_page

Returns the content for the current page

delete(*args, **options)

delete(*args, **options, &)

each(*args, **options)

each(*args, **options, &)

event_handler

header

id

index(*args, **options)

index(*args, **options, &)

keyboard

next_button_procs

next_button_procs=(next_button_procs : Array(Proc(PaginatedKeyboard, Nil)))

on_back

Adds a back button callback handler

on_next

Adds a next button callback handler

pages

Returns each page, with it's items

per_page

per_page=(per_page : Int32)

prefix

prefix=(prefix : String | Nil)

push(*args, **options)

push(*args, **options, &)

results

results=(results : Array(String))