class
Opal::UI::Button
- Opal::UI::Button
- Opal::UI::Control
- Opal::UI::Element
- Reference
- Object
Overview
Focusable, interactive Button component supporting styles (:primary, :secondary, :outline, :danger, :success, :ghost), toggle modes, icons, keyboard shortcuts, and mouse clicks.
Defined in:
opal/ui/components/button.crConstructors
- .new(label : String, icon : String | Nil = nil, variant : Symbol = :primary, toggle : Bool = false, active : Bool = false, disabled : Bool = false, shortcut_char : Char | Nil = nil, on_click : Proc(Button, Nil) | Nil = nil)
- .new(label : String, icon : String | Nil = nil, variant : Symbol = :primary, toggle : Bool = false, active : Bool = false, disabled : Bool = false, shortcut_char : Char | Nil = nil, &block : Button -> Nil) : Button
Instance Method Summary
- #active=(active : Bool)
- #active? : Bool
- #active_bg : Color | Nil
- #active_bg=(active_bg : Color | Nil)
- #active_fg : Color | Nil
- #active_fg=(active_fg : Color | Nil)
- #bg : Color | Nil
- #bg=(bg : Color | Nil)
- #border_fg : Color | Nil
- #border_fg=(border_fg : Color | Nil)
- #border_style : Border | Nil
- #border_style=(border_style : Border | Nil)
-
#click : self
Triggers a button activation/click
- #disabled=(disabled : Bool)
- #disabled? : Bool
- #effective_bg : Color
- #effective_fg : Color
-
#fg : Color | Nil
Manipulable theme properties
-
#fg=(fg : Color | Nil)
Manipulable theme properties
-
#handle_key(key : Terminal::KeyEvent) : Bool
Default key event handler.
-
#handle_mouse(event : Terminal::MouseEvent) : Bool
Default mouse event handler.
- #hover_bg : Color | Nil
- #hover_bg=(hover_bg : Color | Nil)
- #hover_fg : Color | Nil
- #hover_fg=(hover_fg : Color | Nil)
- #icon : String | Nil
- #icon=(icon : String | Nil)
- #label : String
- #label=(label : String)
- #on_click : Proc(Button, Nil) | Nil
- #on_click(&block : Button -> Nil) : self
- #on_click=(on_click : Proc(Button, Nil) | Nil)
- #preferred_size(available_w : Int32, available_h : Int32) : Tuple(Int32, Int32)
- #render(buffer : Buffer, x : Int32, y : Int32, width : Int32, height : Int32) : Nil
- #shortcut_char : Char | Nil
- #shortcut_char=(shortcut_char : Char | Nil)
- #toggle=(toggle : Bool)
- #toggle? : Bool
- #variant : Symbol
- #variant=(variant : Symbol)
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(label : String, icon : String | Nil = nil, variant : Symbol = :primary, toggle : Bool = false, active : Bool = false, disabled : Bool = false, shortcut_char : Char | Nil = nil, on_click : Proc(Button, Nil) | Nil = nil)
#
def self.new(label : String, icon : String | Nil = nil, variant : Symbol = :primary, toggle : Bool = false, active : Bool = false, disabled : Bool = false, shortcut_char : Char | Nil = nil, &block : Button -> Nil) : Button
#
Instance Method Detail
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.
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.