class RatatuiRuby::Terminal::Viewport

Viewport configuration for terminal initialization.

Determines how RatatuiRuby interacts with the terminal:

# Fullscreen (default behavior)
RatatuiRuby.run { |tui| ... }

# Inline with 8 lines
RatatuiRuby.run(viewport: :inline, height: 8) { |tui| ... }

Source

# File lib/ratatui_ruby/terminal/viewport.rb, line 46
def self.fullscreen
  new(type: :fullscreen)
end

Creates a fullscreen viewport (alternate screen).

Source

# File lib/ratatui_ruby/terminal/viewport.rb, line 52
def self.inline(height)
  new(type: :inline, height:)
end

Creates an inline viewport with the given height.

Source

# File lib/ratatui_ruby/terminal/viewport.rb, line 63
def initialize(type:, height: nil)
  super
end

Creates a new viewport configuration.

type: Symbol representing viewport type (:fullscreen or :inline).
height: Integer height in lines (required for :inline, ignored for :fullscreen).

Most developers use {.fullscreen} or {.inline} factory methods instead.

Calls superclass method

Source

# File lib/ratatui_ruby/terminal/viewport.rb, line 69
def fullscreen?
  type == :fullscreen
end

Returns true if this is a fullscreen viewport.

Source

# File lib/ratatui_ruby/terminal/viewport.rb, line 75
def inline?
  type == :inline
end

Returns true if this is an inline viewport.