class Opal::UI::Dropdown

Overview

Interactive Dropdown / Select control. Displays the current selection in a collapsed box and expands into a scrollable popup list on activation. Automatically flips orientation upwards if positioned near the bottom of the screen.

Defined in:

opal/ui/components/dropdown.cr

Constructors

Instance Method Summary

Constructor methods inherited from class Opal::UI::Control

new new

Instance methods inherited from module Opal::UI::InputHookable

custom_inputs=(custom_inputs : Bool) custom_inputs=, custom_inputs? : Bool custom_inputs?, default_input_proc : Proc(InputEvent, Bool) | Nil default_input_proc, default_input_proc=(default_input_proc : Proc(InputEvent, Bool) | Nil) default_input_proc=, fallback_to_defaults!(enabled : Bool = true) : self fallback_to_defaults!, fallback_to_defaults=(fallback_to_defaults : Bool) fallback_to_defaults=, fallback_to_defaults? : Bool fallback_to_defaults?, focus : self focus, focused=(focused : Bool) focused=, focused? : Bool focused?, handle_default_input(event : InputEvent) : Bool handle_default_input, handle_input(event : InputEvent) : Bool handle_input, handle_key(key : Terminal::KeyEvent) : Bool handle_key, handle_mouse(event : Terminal::MouseEvent) : Bool handle_mouse, input_hook : Proc(InputEvent, Bool) | Nil input_hook, input_hook=(input_hook : Proc(InputEvent, Bool) | Nil) input_hook=, on_input(&block : self, InputEvent -> Bool) : self on_input, puppet(&block : self, InputEvent -> Bool) : self puppet, reset_inputs : self reset_inputs, setup_default_inputs : Nil setup_default_inputs, unfocus : self unfocus, use_custom_inputs!(enabled : Bool = true) : self use_custom_inputs!

Instance methods inherited from class Opal::UI::Element

add_class(name : String) : self add_class, children : Array(Element) children, classes : Set(String) classes, classes=(classes : Set(String)) classes=, has_class?(name : String) : Bool has_class?, id : String | Nil id, id=(id : String | Nil) id=, preferred_print_size(available_w : Int32) : Tuple(Int32, Int32) preferred_print_size, preferred_size(available_w : Int32, available_h : Int32) : Tuple(Int32, Int32) preferred_size, print(io : IO = STDOUT, width : Int32 | Nil = nil, color : Bool | Nil = nil, theme : Theme | Nil = nil) : Nil print, query(selector : String) : Array(Element)
query(klass : T.class) : Array(T) forall T query, query_one(selector : String) : Element
query_one(klass : T.class) : T forall T query_one, query_one?(selector : String) : Element | Nil
query_one?(klass : T.class) : T | Nil forall T query_one?, remove_class(name : String) : self remove_class, render(buffer : Buffer, x : Int32, y : Int32, width : Int32, height : Int32) : Nil render, render_print(buffer : Buffer, width : Int32, height : Int32) : Nil render_print, to_print_s(width : Int32 | Nil = nil, color : Bool | Nil = nil, theme : Theme | Nil = nil) : String to_print_s, to_string(width : Int32 | Nil = nil, color : Bool | Nil = nil, theme : Theme | Nil = nil) : String to_string

Instance methods inherited from module Opal::UI::Themable

current_theme : Theme current_theme, style(&block : self -> Nil) : self style, theme : Theme | Nil theme, theme=(theme : Theme | Nil) theme=, with_theme(new_theme : Theme | Symbol | String) : self with_theme

Constructor Detail

def self.new(items : Array(String), selected_index : Int32 = 0, placeholder : String = "Select...", expanded : Bool = false, max_visible_items : Int32 = 6, on_change : Proc(Int32, String, Nil) | Nil = nil, style : DropdownStyle = DropdownStyle::Classic) #

[View source]
def self.new(items : Array(String), selected_index : Int32 = 0, placeholder : String = "Select...", expanded : Bool = false, max_visible_items : Int32 = 6, &block : Int32, String -> Nil) : Dropdown #

[View source]

Instance Method Detail

def arrow_down_glyph : String | Nil #

[View source]
def arrow_down_glyph=(arrow_down_glyph : String | Nil) #

[View source]
def arrow_glyph : String | Nil #

[View source]
def arrow_glyph=(g : String | Nil) #

[View source]
def arrow_up_glyph : String | Nil #

[View source]
def arrow_up_glyph=(arrow_up_glyph : String | Nil) #

[View source]
def border : Border | Nil #

[View source]
def border=(b : Border | Nil) #

[View source]
def border_fg : Color | Nil #

[View source]
def border_fg=(border_fg : Color | Nil) #

[View source]
def border_style : Border | Nil #

[View source]
def border_style=(border_style : Border | Nil) #

[View source]
def close : self #

[View source]
def expanded=(expanded : Bool) #

[View source]
def expanded? : Bool #

[View source]
def filtered_items : Array(String) #

[View source]
def handle_key(key : Terminal::KeyEvent) : Bool #
Description copied from module Opal::UI::InputHookable

Default key event handler. Override in subclasses if not using @default_input_proc.


[View source]
def handle_mouse(event : Terminal::MouseEvent) : Bool #
Description copied from module Opal::UI::InputHookable

Default mouse event handler. Override in subclasses if not using @default_input_proc.


[View source]
def items : Array(String) #

[View source]
def items=(items : Array(String)) #

[View source]
def max_visible_items : Int32 #

[View source]
def max_visible_items=(max_visible_items : Int32) #

[View source]
def normal_bg : Color | Nil #

[View source]
def normal_bg=(normal_bg : Color | Nil) #

[View source]
def normal_fg : Color | Nil #

Manipulable theme properties and character swaps


[View source]
def normal_fg=(normal_fg : Color | Nil) #

Manipulable theme properties and character swaps


[View source]
def on_change : Proc(Int32, String, Nil) | Nil #

[View source]
def on_change(&block : Int32, String -> Nil) : self #

[View source]
def on_change=(on_change : Proc(Int32, String, Nil) | Nil) #

[View source]
def open : self #

[View source]
def placeholder : String #

[View source]
def placeholder=(placeholder : String) #

[View source]
def popup_bg : Color | Nil #

[View source]
def popup_bg=(popup_bg : Color | Nil) #

[View source]
def preferred_size(available_w : Int32, available_h : Int32) : Tuple(Int32, Int32) #

[View source]
def render(buffer : Buffer, x : Int32, y : Int32, width : Int32, height : Int32) : Nil #

[View source]
def scroll_offset : Int32 #

[View source]
def scroll_offset=(scroll_offset : Int32) #

[View source]
def search_query : String #

[View source]
def search_query=(search_query : String) #

[View source]
def select(index : Int32) : self #

Convenience alias


[View source]
def select_index(index : Int32) : self #

Sets selection by index, updating scroll position and firing callback


[View source]
def selected_bg : Color | Nil #

[View source]
def selected_bg=(selected_bg : Color | Nil) #

[View source]
def selected_fg : Color | Nil #

[View source]
def selected_fg=(selected_fg : Color | Nil) #

[View source]
def selected_index : Int32 #

[View source]
def selected_index=(selected_index : Int32) #

[View source]
def selected_item : String #

Returns the currently selected item label, or placeholder if empty


[View source]
def style : DropdownStyle #

[View source]
def style=(style : DropdownStyle) #

[View source]
def toggle : self #

Toggles popup open/closed


[View source]