class

Opal::UI::Button

Inherits Opal::UI::Control < Opal::UI::InputHookable < Opal::UI::Element < Opal::UI::Themable < Reference < Object

Focusable, interactive Button component supporting styles (:primary, :secondary, :outline, :danger, :success, :ghost), toggle modes, icons, keyboard shortcuts, and mouse clicks.

Constructors

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 methods

active=(active : Bool)

active?

active_bg

active_bg=(active_bg : Color | Nil)

active_fg

active_fg=(active_fg : Color | Nil)

bg

bg=(bg : Color | Nil)

border_fg

border_fg=(border_fg : Color | Nil)

border_style

border_style=(border_style : Border | Nil)

click

Triggers a button activation/click

disabled=(disabled : Bool)

disabled?

effective_bg

effective_fg

fg

Manipulable theme properties

fg=(fg : Color | Nil)

Manipulable theme properties

handle_key(key : Terminal::KeyEvent) : Bool

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

handle_mouse(event : Terminal::MouseEvent) : Bool

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

hover_bg

hover_bg=(hover_bg : Color | Nil)

hover_fg

hover_fg=(hover_fg : Color | Nil)

icon

icon=(icon : String | Nil)

label

label=(label : String)

on_click

on_click

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

shortcut_char=(shortcut_char : Char | Nil)

toggle=(toggle : Bool)

toggle?

variant

variant=(variant : Symbol)