class Opal::UI::SplitView

Overview

Multi-pane split view container supporting horizontal (side-by-side) and vertical (stacked) layouts with configurable proportions and borders.

Defined in:

opal/ui/components/split_view.cr
opal/ui/dsl.cr

Constructors

Instance Method Summary

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.horizontal(first : Element | Nil = nil, second : Element | Nil = nil, ratio : Float64 | Nil = 0.5, first_width : Int32 | Nil = nil, second_width : Int32 | Nil = nil, min_first_width : Int32 | Nil = nil, max_first_width : Int32 | Nil = nil, separator : Char | Nil = nil, separator_fg : Color | Symbol | String = Color.none, focused_pane : Symbol = :first, show_separator : Bool = true) : SplitView #

[View source]
def self.horizontal(ratio : Float64 | Nil = 0.5, first_width : Int32 | Nil = nil, second_width : Int32 | Nil = nil, min_first_width : Int32 | Nil = nil, max_first_width : Int32 | Nil = nil, separator : Char | Nil = nil, separator_fg : Color | Symbol | String = Color.none, focused_pane : Symbol = :first, show_separator : Bool = true, &) : SplitView #

[View source]
def self.new(first : Element | Nil = nil, second : Element | Nil = nil, direction : SplitDirection | Symbol | String = SplitDirection::Horizontal, ratio : Float64 | Nil = 0.5, first_size : Int32 | Nil = nil, second_size : Int32 | Nil = nil, min_first_size : Int32 | Nil = nil, max_first_size : Int32 | Nil = nil, separator : Char | Nil = nil, separator_fg : Color | Symbol | String = Color.none, focused_pane : Symbol = :first, show_separator : Bool = true) #

[View source]
def self.new(direction : SplitDirection | Symbol | String = SplitDirection::Horizontal, ratio : Float64 | Nil = 0.5, first_size : Int32 | Nil = nil, second_size : Int32 | Nil = nil, min_first_size : Int32 | Nil = nil, max_first_size : Int32 | Nil = nil, separator : Char | Nil = nil, separator_fg : Color | Symbol | String = Color.none, focused_pane : Symbol = :first, show_separator : Bool = true, &) : SplitView #

[View source]
def self.vertical(first : Element | Nil = nil, second : Element | Nil = nil, ratio : Float64 | Nil = 0.5, first_height : Int32 | Nil = nil, second_height : Int32 | Nil = nil, min_first_height : Int32 | Nil = nil, max_first_height : Int32 | Nil = nil, separator : Char | Nil = nil, separator_fg : Color | Symbol | String = Color.none, focused_pane : Symbol = :first, show_separator : Bool = true) : SplitView #

[View source]
def self.vertical(ratio : Float64 | Nil = 0.5, first_height : Int32 | Nil = nil, second_height : Int32 | Nil = nil, min_first_height : Int32 | Nil = nil, max_first_height : Int32 | Nil = nil, separator : Char | Nil = nil, separator_fg : Color | Symbol | String = Color.none, focused_pane : Symbol = :first, show_separator : Bool = true, &) : SplitView #

[View source]

Instance Method Detail

def adjust_ratio(delta : Float64, min_ratio : Float64 = 0.1, max_ratio : Float64 = 0.9) : Float64 #

Adjusts split ratio by delta, clamped within [min_ratio, max_ratio].


[View source]
def direction : SplitDirection #

[View source]
def direction=(direction : SplitDirection) #

[View source]
def first : Element | Nil #

[View source]
def first=(first : Element | Nil) #

[View source]
def first_size : Int32 | Nil #

[View source]
def first_size=(first_size : Int32 | Nil) #

[View source]
def focus_first : Nil #

[View source]
def focus_second : Nil #

[View source]
def focused_pane : Symbol #

[View source]
def focused_pane=(focused_pane : Symbol) #

[View source]
def max_first_size : Int32 | Nil #

[View source]
def max_first_size=(max_first_size : Int32 | Nil) #

[View source]
def min_first_size : Int32 | Nil #

[View source]
def min_first_size=(min_first_size : Int32 | Nil) #

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

[View source]
def ratio : Float64 | Nil #

[View source]
def ratio=(ratio : Float64 | Nil) #

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

[View source]
def second : Element | Nil #

[View source]
def second=(second : Element | Nil) #

[View source]
def second_size : Int32 | Nil #

[View source]
def second_size=(second_size : Int32 | Nil) #

[View source]
def separator : Char #

[View source]
def separator=(separator : Char) #

[View source]
def separator_fg : Color #

[View source]
def separator_fg=(separator_fg : Color) #

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

[View source]
def show_separator? : Bool #

[View source]
def toggle_focus : Symbol #

Toggles active focus between :first and :second pane.


[View source]