module TUI::Term

Defined in:

tui/core/term.cr

Constant Summary

BJ = "┴"

BL = "╰"

BLINK = "\e[5m"

BOLD = "\e[1m"

BR = "╯"

CJ = "┼"

DIM = "\e[2m"

HL = "─"

ITALIC = "\e[3m"

LJ = "├"

RESET = "\e[0m"

REVERSE = "\e[7m"

RJ = "┤"

STRIKETHROUGH = "\e[9m"

TJ = "┬"

TL = "╭"

Box-drawing characters. Corners are rounded (matching lazygit's border style); T-junctions/cross stay square, which is standard even in rounded-corner box styles (there's no rounded T-junction glyph).

TR = "╮"

UNDERLINE = "\e[4m"

VL = "│"

Class Method Summary

• .apply(style : Style, s : String) : String

  Concatenates the SGR codes for every attribute set on style, then applies them all at once and resets at the end — the composable counterpart to #bold/#dim/#reverse/#fg/#bg, which each only ever apply one attribute and previously had to be manually nested to combine (e.g.

• .bg(color : Color, s : String) : String
• .bold(s : String) : String
• .border_line(segment_widths : Array(Int32), left : String, fill : String, junction : String, right : String) : String

  Composes one horizontal border row: left + N segments of fill repeated to each width, joined by junction, + right.

• .clear : String
• .dim(s : String) : String
• .enter_alt_screen : String
• .enter_bracketed_paste : String

  Bracketed paste mode (mode 2004): the terminal wraps a pasted block in \e[200~/\e[201~ markers instead of sending it as ordinary keystrokes, so Keys.parse_bracketed_paste can recognize it as one paste operation.

• .enter_mouse : String

  SGR extended mouse reporting (mode 1000 reports button/wheel events, mode 1006 switches to the SGR encoding Keys.parse_sgr_mouse expects — plain mode 1000 alone caps coordinates at 223 and uses a different, ambiguous byte encoding).

• .enter_raw : Nil
• .escape(style : Style) : String

  The full escape sequence for style (e.g.

• .exit_raw : Nil
• .fg(color : Color, s : String) : String
• .fit(s : String, width : Int32, align : Align = Align::Left) : String

  Pad or truncate to exactly width visible columns.

• .hide_cursor : String
• .leave_alt_screen : String
• .leave_bracketed_paste : String
• .leave_mouse : String
• .move(row : Int32, col : Int32) : String
• .overlay(s : String, code : String) : String

  Layers an extra SGR code (e.g.

• .reverse(s : String) : String
• .sgr_code(style : Style) : String

  The bare SGR code string for style, with no wrapping \e[/m/ RESET — the numeric parameters only, e.g.

• .show_cursor : String
• .size : NamedTuple(rows: Int32, cols: Int32)
• .strip_ansi(s : String) : String

  Strip all ANSI escape sequences, returning plain visible text.

• .trunc(s : String, width : Int32) : String

  Truncate string to width visible columns, appending "…" if cut.

• .visible_size(s : String) : Int32

  Visible (printable) length — excludes ANSI escape sequences.

Class Method Detail