class

Bubbles::List::Model

Inherits Bubbles::Help::KeyMap < Reference < Object

Constructors

new(items : Array(Item), delegate : ItemDelegate, width : Int32, height : Int32)

Instance methods

additional_full_help_keys

additional_full_help_keys=(additional_full_help_keys : Proc(Array(Bubbles::Key::Binding)) | Nil)

additional_short_help_keys

additional_short_help_keys=(additional_short_help_keys : Proc(Array(Bubbles::Key::Binding)) | Nil)

cursor

Cursor returns the index of the cursor on the current page.

cursor=(cursor : Int32)

cursor_down

cursor_up

delegate

delegate=(delegate : ItemDelegate)

disable_quit_keybindings

disable_quit_keybindings=(disable_quit_keybindings : Bool)

filter

filter=(filter : FilterFunc)

filter_input

filter_input=(filter_input : Bubbles::TextInput::Model)

filter_state

FilterState returns the current filter state.

filter_state=(filter_state : FilterState)

filter_value

FilterValue returns the current value of the filter.

filtered

IsFiltered returns whether or not the list is currently filtered. It's purely a convenience method.

filtered?

filtered_items

filtered_items=(filtered_items : Array(FilteredItem) | Nil)

filtering_enabled

FilteringEnabled returns whether or not filtering is enabled.

filtering_enabled=(filtering_enabled : Bool)

full_help

global_index

go_to_end

go_to_start

height

Height returns the current height setting.

height=(height : Int32)

help

help=(help : Bubbles::Help::Model)

index

infinite_scrolling

infinite_scrolling=(infinite_scrolling : Bool)

init

insert_item(index : Int32, item : Item) : Tea::Cmd | Nil

item_name_plural

item_name_plural=(item_name_plural : String)

item_name_singular

item_name_singular=(item_name_singular : String)

items

Items returns the items in the list.

items=(items : Array(Item))

key_map

key_map=(key_map : KeyMap)

matches_for_item(index : Int32) : Array(Int32) | Nil

new_status_message(s : String) : Tea::Cmd

next_page

paginator

paginator=(paginator : Bubbles::Paginator::Model)

prev_page

remove_item(index : Int32)

reset_filter

reset_selected

select(index : Int32)

select_item(index : Int32)

selected_item

set_delegate(d : ItemDelegate)

set_filter_state(state : FilterState)

set_filter_text(filter_text : String)

set_filtering_enabled(v : Bool)

set_height(v : Int32)

set_item(index : Int32, item : Item) : Tea::Cmd | Nil

set_items(i : Array(Item)) : Tea::Cmd | Nil

set_show_filter(v : Bool)

set_show_help(v : Bool)

set_show_pagination(v : Bool)

set_show_status_bar(v : Bool)

set_show_title(v : Bool)

set_size(width : Int32, height : Int32)

set_spinner(spinner_data : Bubbles::Spinner::SpinnerData)

set_status_bar_item_name(singular : String, plural : String)

set_width(v : Int32)

setting_filter

SettingFilter returns whether or not the user is currently editing the filter value. It's purely a convenience method.

setting_filter?

short_help

show_filter

ShowFilter returns whether or not the filter is set to be rendered. Note that this is separate from FilteringEnabled, so filtering can be hidden yet still invoked. This allows you to render filtering differently without having to re-implement it from scratch.

show_filter=(show_filter : Bool)

show_help

ShowHelp returns whether or not the help is set to be rendered.

show_help=(show_help : Bool)

show_pagination

ShowPagination returns whether the pagination is visible.

show_pagination=(show_pagination : Bool)

show_spinner

show_spinner=(show_spinner : Bool)

show_status_bar

ShowStatusBar returns whether or not the status bar is set to be rendered.

show_status_bar=(show_status_bar : Bool)

show_title

ShowTitle returns whether or not the title bar is set to be rendered.

show_title=(show_title : Bool)

spinner

spinner=(spinner : Bubbles::Spinner::Model)

start_spinner

status_bar_item_name

status_message

status_message=(status_message : String)

status_message_lifetime

status_message_lifetime=(status_message_lifetime : Time::Span)

status_view

stop_spinner

styles

styles=(styles : Styles)

title

title=(title : String)

toggle_spinner

update(msg : Tea::Msg) : Tuple(self, Tea::Cmd | Nil)

view

visible_items

width

Width returns the current width setting.

width=(width : Int32)