class
Opal::UI::Box
- Opal::UI::Box
- Opal::UI::Element
- Reference
- Object
Overview
Container component providing border, padding, and an optional embedded title.
Defined in:
opal/ui/components/box.crConstructors
- .new(child : Element | Nil = nil, border : Symbol | Border | String | Nil = nil, border_fg : Color | Symbol | String | Nil = nil, padding : Int32 = 0, title : String | Nil = nil, title_fg : Color | Symbol | String | Nil = nil, bg : Color | Symbol | String = Color.none)
- .new(border : Symbol | Border | String | Nil = nil, border_fg : Color | Symbol | String | Nil = nil, padding : Int32 = 0, title : String | Nil = nil, title_fg : Color | Symbol | String | Nil = nil, bg : Color | Symbol | String = Color.none, &)
Class Method Summary
-
.print(text : String, title : String | Nil = nil, io : IO = STDOUT, border : Symbol | Border | String = :rounded, border_fg : Color | Symbol | String = Color.none, padding : Int32 = 1, width : Int32 | Nil = nil, color : Bool | Nil = nil, theme : Theme | Nil = nil) : Nil
Class convenience method printing styled box directly to IO
-
.to_string(text : String, title : String | Nil = nil, border : Symbol | Border | String = :rounded, border_fg : Color | Symbol | String = Color.none, padding : Int32 = 1, width : Int32 | Nil = nil, color : Bool | Nil = nil, theme : Theme | Nil = nil) : String
Class convenience method returning styled box string
Instance Method Summary
-
#<<(element : Element) : self
Shovel alias for
#add -
#add(element : Element) : self
Appends a child element to the box.
- #bg : Color
- #bg=(bg : Color)
- #border : Border | Nil
- #border=(border : Border | Nil)
- #border_fg : Color | Nil
- #border_fg=(border_fg : Color | Nil)
- #child : Element | Nil
- #child=(child : Element | Nil)
-
#children : Array(Element)
Returns child elements for hierarchical tree traversal and DOM querying
- #padding_bottom : Int32
- #padding_bottom=(padding_bottom : Int32)
- #padding_left : Int32
- #padding_left=(padding_left : Int32)
- #padding_right : Int32
- #padding_right=(padding_right : Int32)
- #padding_top : Int32
- #padding_top=(padding_top : Int32)
- #preferred_size(available_w : Int32, available_h : Int32) : Tuple(Int32, Int32)
- #render(buffer : Buffer, x : Int32, y : Int32, width : Int32, height : Int32) : Nil
- #title : String | Nil
- #title=(title : String | Nil)
- #title_fg : Color | Nil
- #title_fg=(title_fg : Color | Nil)
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(child : Element | Nil = nil, border : Symbol | Border | String | Nil = nil, border_fg : Color | Symbol | String | Nil = nil, padding : Int32 = 0, title : String | Nil = nil, title_fg : Color | Symbol | String | Nil = nil, bg : Color | Symbol | String = Color.none)
#
def self.new(border : Symbol | Border | String | Nil = nil, border_fg : Color | Symbol | String | Nil = nil, padding : Int32 = 0, title : String | Nil = nil, title_fg : Color | Symbol | String | Nil = nil, bg : Color | Symbol | String = Color.none, &)
#
Class Method Detail
def self.print(text : String, title : String | Nil = nil, io : IO = STDOUT, border : Symbol | Border | String = :rounded, border_fg : Color | Symbol | String = Color.none, padding : Int32 = 1, width : Int32 | Nil = nil, color : Bool | Nil = nil, theme : Theme | Nil = nil) : Nil
#
Class convenience method printing styled box directly to IO
def self.to_string(text : String, title : String | Nil = nil, border : Symbol | Border | String = :rounded, border_fg : Color | Symbol | String = Color.none, padding : Int32 = 1, width : Int32 | Nil = nil, color : Bool | Nil = nil, theme : Theme | Nil = nil) : String
#
Class convenience method returning styled box string
Instance Method Detail
Appends a child element to the box. If a child already exists, wraps both in a VStack.
Description copied from class Opal::UI::Element
Returns child elements for hierarchical tree traversal and DOM querying