module RatatuiRuby::TUI::LayoutFactories

Layout factory methods for Session.

Provides convenient access to Layout::Rect, Layout::Constraint, and Layout::Layout without fully qualifying the class names.

Public Instance Methods

constraint (...)

Source

# File lib/ratatui_ruby/tui/layout_factories.rb, line 23
def constraint(...)
  Layout::Constraint.new(...)
end

Creates a Layout::Constraint. @return [Layout::Constraint]

constraint_fill (n = 1)

Source

# File lib/ratatui_ruby/tui/layout_factories.rb, line 53
def constraint_fill(n = 1)
  Layout::Constraint.fill(n)
end

Creates a Layout::Constraint.fill. @return [Layout::Constraint]

constraint_length (n)

Source

# File lib/ratatui_ruby/tui/layout_factories.rb, line 29
def constraint_length(n)
  Layout::Constraint.length(n)
end

Creates a Layout::Constraint.length. @return [Layout::Constraint]

constraint_max (n)

Source

# File lib/ratatui_ruby/tui/layout_factories.rb, line 47
def constraint_max(n)
  Layout::Constraint.max(n)
end

Creates a Layout::Constraint.max. @return [Layout::Constraint]

constraint_min (n)

Source

# File lib/ratatui_ruby/tui/layout_factories.rb, line 41
def constraint_min(n)
  Layout::Constraint.min(n)
end

Creates a Layout::Constraint.min. @return [Layout::Constraint]

constraint_percentage (n)

Source

# File lib/ratatui_ruby/tui/layout_factories.rb, line 35
def constraint_percentage(n)
  Layout::Constraint.percentage(n)
end

Creates a Layout::Constraint.percentage. @return [Layout::Constraint]

constraint_ratio (numerator, denominator)

Source

# File lib/ratatui_ruby/tui/layout_factories.rb, line 59
def constraint_ratio(numerator, denominator)
  Layout::Constraint.ratio(numerator, denominator)
end

Creates a Layout::Constraint.ratio. @return [Layout::Constraint]

fixed (n)

Source

# File lib/ratatui_ruby/tui/layout_factories.rb, line 83
def fixed(n)
  constraint_length(n)
end

Alias for {#constraint_length} — CSS-inspired “fixed” sizing. @return [Layout::Constraint]

flex (n = 1)

Source

# File lib/ratatui_ruby/tui/layout_factories.rb, line 95
def flex(n = 1)
  constraint_fill(n)
end

Alias for {#constraint_fill} — CSS Flexbox-inspired flexible sizing. @return [Layout::Constraint]

fr (n = 1)

Source

# File lib/ratatui_ruby/tui/layout_factories.rb, line 101
def fr(n = 1)
  constraint_fill(n)
end

Alias for {#constraint_fill} — CSS Grid-inspired “fr” (fraction) unit. @return [Layout::Constraint]

layout (...)

Source

# File lib/ratatui_ruby/tui/layout_factories.rb, line 65
def layout(...)
  Layout::Layout.new(...)
end

Creates a Layout::Layout. @return [Layout::Layout]

layout_split (area, direction: :vertical, constraints:, flex: :legacy)

Source

# File lib/ratatui_ruby/tui/layout_factories.rb, line 71
def layout_split(area, direction: :vertical, constraints:, flex: :legacy)
  Layout::Layout.split(area, direction:, constraints:, flex:)
end

Splits an area using Layout::Layout.split. @return [Array<Layout::Rect>]

percent (n)

Source

# File lib/ratatui_ruby/tui/layout_factories.rb, line 89
def percent(n)
  constraint_percentage(n)
end

Alias for {#constraint_percentage} — CSS-inspired percent sizing. @return [Layout::Constraint]

rect (...)

Source

# File lib/ratatui_ruby/tui/layout_factories.rb, line 17
def rect(...)
  Layout::Rect.new(...)
end

Creates a Layout::Rect. @return [Layout::Rect]

split (area, direction: :vertical, constraints:, flex: :legacy)

Source

# File lib/ratatui_ruby/tui/layout_factories.rb, line 77
def split(area, direction: :vertical, constraints:, flex: :legacy)
  layout_split(area, direction:, constraints:, flex:)
end

Alias for {#layout_split} — shorter, more ergonomic. @return [Array<Layout::Rect>]