module

Tea::Options

Program options

Class methods

with_alt_screen

WithAltScreen starts the program with alternate screen enabled

Source
with_bracketed_paste

WithBracketedPaste enables bracketed paste mode

Source
with_color_profile(profile : Ultraviolet::ColorProfile) : ProgramOption

WithColorProfile sets the color profile to use. Forces a specific color profile instead of auto-detecting.

Source
with_context(ctx : ExecutionContext) : ProgramOption

WithContext sets the context for the program

Source
with_environment(env : Ultraviolet::Environ) : ProgramOption

WithEnvironment sets the environment variables for the program. This is useful when running in remote sessions (e.g. SSH).

Source
with_filter

WithFilter sets an event filter function. The filter can return any Msg, or nil to ignore the event.

Source
with_fps(fps : Int32) : ProgramOption

WithFPS sets a custom maximum fps (1-120)

Source
with_input(input : IO | Nil) : ProgramOption

WithInput sets the input reader (default: STDIN) Pass nil to disable input entirely

Source
with_mouse_all_motion

WithMouseAllMotion enables all mouse motion tracking

Source
with_mouse_cell_motion

WithMouseCellMotion enables mouse cell motion tracking

Source
with_output(output : IO) : ProgramOption

WithOutput sets the output writer (default: STDOUT)

Source
with_report_focus

WithReportFocus enables focus reporting

Source
with_window_size(width : Int32, height : Int32) : ProgramOption

WithWindowSize sets the initial terminal window size. Useful for testing or non-interactive environments.

Source
without_catch_panics

WithoutCatchPanics disables panic catching. If disabled, the terminal may be left in an unusable state after a panic.

Source
without_input

WithoutInput disables all input

Source
without_renderer

WithoutRenderer disables the renderer. Output will be sent directly without rendering logic.

Source
without_signal_handler

WithoutSignalHandler disables the signal handler. Useful if you want to handle signals yourself.

Source
without_signals

WithoutSignals ignores OS signals. Mainly useful for testing.

Source