class

Tea::Program

Inherits Reference < Object

Extend Program class with TTY functionality

Constants

SUSPEND_SUPPORTED = true

Suspension support flag

Constructors

new(initial_model : Model | Nil = nil)

Instance methods

check_resize

Check and report terminal resize

disable_catch_panics=(disable_catch_panics : Bool)

disable_catch_panics?

disable_input=(disable_input : Bool)

disable_input?

disable_renderer=(disable_renderer : Bool)

disable_renderer?

disable_signal_handler=(disable_signal_handler : Bool)

disable_signal_handler?

env

Environment

env=(env : Ultraviolet::Environ)

Environment

exec(cmd : ExecCommand, callback : ExecCallback | Nil)

exec runs an ExecCommand and delivers results to the program Matches Go's exec method logic exactly

execute(sequence : String)

Execute writes an ANSI sequence to the output buffer

external_context

external_context=(external_context : ExecutionContext | Nil)

filter

filter=(filter : Proc(Model, Msg, Msg | Nil) | Nil)

flush

Flush writes the output buffer to the actual output

fps

Configuration options

fps=(fps : Int32)

Configuration options

height

height=(height : Int32)

ignore_signals=(ignore_signals : Bool)

Internal state

ignore_signals?

Internal state

init_input

Initialize TTY input (set raw mode, etc.) Platform-specific implementation

init_input_reader(cancel : Bool = false) : Exception | Nil

(Re)start input reading

init_terminal

Initialize terminal (called at program start)

initial_model

initial_model=(initial_model : Model | Nil)

input

Input handling

input=(input : IO | Nil)

Input handling

kill

Kill stops the program immediately and restores terminal state

listen_for_resize(done : Channel(Nil))

Listen for window resize events (SIGWINCH on Unix)

output

Output handling

output=(output : IO | Nil)

Output handling

profile

Color profile override (nil = auto-detect from renderer/terminal)

profile=(profile : Ultraviolet::ColorProfile | Nil)

Color profile override (nil = auto-detect from renderer/terminal)

quit

Quit the program

release_terminal(reset : Bool) : Exception | Nil

releaseTerminal releases terminal control for external commands

restore_input

Restore TTY input to original state

restore_terminal

restore_terminal restores terminal control after external commands

restore_terminal_state

Restore terminal to original state

run(context : ExecutionContext | Nil = nil) : Tuple(Model | Nil, Exception | Nil)

Start the program with the given context ameba:disable Metrics/CyclomaticComplexity

running?

Check if the program is running

send(cmd : Cmd | Nil)

Send a command to be executed

send(msg : Msg)

Send a message to the program

shutdown(kill : Bool)

Shutdown performs cleanup and restores terminal state

startup_alt_screen=(startup_alt_screen : Bool)

startup_alt_screen?

startup_bracketed_paste=(startup_bracketed_paste : Bool)

startup_bracketed_paste?

startup_mouse_mode

startup_mouse_mode=(startup_mouse_mode : MouseMode | Nil)

startup_report_focus=(startup_report_focus : Bool)

startup_report_focus?

suspend

Suspend the program (send SIGTSTP)

translate_input_event(event : Ultraviolet::Event) : Msg

translate_input_event translates an ultraviolet event into a Bubble Tea message Matches Go's translateInputEvent function ameba:disable Metrics/CyclomaticComplexity

wait

Wait blocks until the program finishes

width

Terminal dimensions

width=(width : Int32)

Terminal dimensions