class RatatuiRuby::Session

Manages the terminal lifecycle and provides a concise API for the render loop.

Writing a TUI loop involves repetitive boilerplate. You constantly instantiate widgets (RatatuiRuby::Paragraph.new) and call global methods (RatatuiRuby.draw). This is verbose and hard to read.

The Session object simplifies this. It acts as a factory and a facade. It provides short helper methods for every widget and delegates core commands to the main module.

Use it within RatatuiRuby.run to build your interface cleanly.

Available Methods

The session dynamically defines factory methods for all RatatuiRuby constants.

• draw(node) -> Delegates to RatatuiRuby.draw

• poll_event -> Delegates to RatatuiRuby.poll_event

Widget Factories

The session acts as a dynamic factory. It creates a helper method for every class defined in the ‘RatatuiRuby` module.

**The Rule:** To instantiate a class like ‘RatatuiRuby::SomeWidget`, call `tui.some_widget(…)`.

**Common Examples:**

• paragraph(...) -> RatatuiRuby::Paragraph.new(...)

• block(...) -> RatatuiRuby::Block.new(...)

• layout(...) -> RatatuiRuby::Layout.new(...)

• list(...) -> RatatuiRuby::List.new(...)

• table(...) -> RatatuiRuby::Table.new(...)

• style(...) -> RatatuiRuby::Style.new(...)

If a new class is added to the library, it is automatically available here.

Nested Helpers

• text_span(...) -> RatatuiRuby::Text::Span.new(...)

• text_line(...) -> RatatuiRuby::Text::Line.new(...)

Examples

Basic Usage (Recommended)

RatatuiRuby.run do |tui|
  loop do
    tui.draw \
      tui.paragraph \
          text: "Hello, Ratatui! Press 'q' to quit.",
          alignment: :center,
          block: tui.block(
            title: "My Ruby TUI App",
            borders: [:all],
            border_color: "cyan"
          )
    event = tui.poll_event
    break if event == "q" || event == :ctrl_c
  end
end

Raw API (Verbose)

RatatuiRuby.run do
  loop do
    RatatuiRuby.draw \
      RatatuiRuby::Paragraph.new(
          text: "Hello, Ratatui! Press 'q' to quit.",
          alignment: :center,
          block: RatatuiRuby::Block.new(
            title: "My Ruby TUI App",
            borders: [:all],
            border_color: "cyan"
          )
      )
    event = RatatuiRuby.poll_event
    break if event == "q" || event == :ctrl_c
  end
end

Mixed Usage (Flexible)

RatatuiRuby.run do |tui|
  loop do
    RatatuiRuby.draw \
      tui.paragraph \
          text: "Hello, Ratatui! Press 'q' to quit.",
          alignment: :center,
          block: tui.block(
            title: "My Ruby TUI App",
            borders: [:all],
            border_color: "cyan"
          )
    event = RatatuiRuby.poll_event
    break if event == "q" || event == :ctrl_c
  end
end