module RatatuiRuby::TUI::LayoutFactories

constraint (type_or_arg = nil, arg1 = nil, arg2 = nil, **)

Source

# File lib/ratatui_ruby/tui/layout_factories.rb, line 44
def constraint(type_or_arg = nil, arg1 = nil, arg2 = nil, **)
  # Type-based dispatch when first arg is a symbol
  if type_or_arg.is_a?(Symbol)
    case type_or_arg
    when :length, :fixed
      constraint_length(arg1 || raise(ArgumentError, "#{type_or_arg} requires a value"))
    when :percentage, :percent
      constraint_percentage(arg1 || raise(ArgumentError, "#{type_or_arg} requires a value"))
    when :min
      constraint_min(arg1 || raise(ArgumentError, "min requires a value"))
    when :max
      constraint_max(arg1 || raise(ArgumentError, "max requires a value"))
    when :fill, :flex, :fr
      constraint_fill(arg1 || 1)
    when :ratio, :aspect
      n = arg1 || raise(ArgumentError, "ratio requires numerator")
      d = arg2 || raise(ArgumentError, "ratio requires denominator")
      constraint_ratio(n, d)
    else
      # Use to_s since type_or_arg must be a Symbol here
      raise ArgumentError, "Unknown constraint type: :#{type_or_arg}. " \
        "Valid types: :length, :percentage, :min, :max, :fill, :ratio"
    end
  elsif type_or_arg.nil? && arg1.nil?
    Layout::Constraint.new(**)
  else
    Layout::Constraint.new(type_or_arg, arg1, arg2, **)
  end
end

Creates a Layout::Constraint, with optional type-based dispatch.

When called with a type symbol as the first argument, dispatches to the appropriate constraint factory (TIMTOWTDI pattern).

Also available as: tui.percent(50), tui.flex(1)

Examples

tui.constraint(:length, 10)     # => Constraint.length(10)
tui.constraint(:percentage, 50) # => Constraint.percentage(50)
tui.constraint(:min, 5)         # => Constraint.min(5)
tui.constraint(:fill, 2)        # => Constraint.fill(2)
tui.constraint(:ratio, 1, 3)    # => Constraint.ratio(1, 3)

@return [Layout::Constraint]

constraint_fill (n = 1)

Source

# File lib/ratatui_ruby/tui/layout_factories.rb, line 100
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 76
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 94
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 88
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 82
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 106
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 130
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 142
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 148
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 112
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 118
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 136
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 124
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>]