Capabilities

termflow.tui.Capabilities
See theCapabilities companion object
final case class Capabilities(colorDepth: ColorDepth, unicode: Boolean, mouse: Boolean, extendedStyles: Boolean, bracketedPaste: Boolean, notifications: NotificationKind)

Best-effort terminal capabilities, populated either from environment variables (see Capabilities.detect) or supplied explicitly by tests.

Value parameters

bracketedPaste

True if the terminal is expected to honour xterm bracketed-paste mode (CSI ?2004h). When false the runtime does not enable the mode at startup and the parser will see the pasted bytes as a stream of individual keypresses, just as if the user had typed them.

colorDepth

Maximum color depth the renderer should emit. Higher-depth colors are downgraded to this depth at render time.

extendedStyles

True if the terminal is expected to honour the extended SGR attributes (Style.italic, Style.dim, Style.reverse, Style.strikethrough, Style.blink). When false, the renderer strips these codes and emits only the universally-supported Style.bold / Style.underline attributes.

mouse

True if the terminal advertises mouse support (xterm-family $TERM values, screen, tmux, alacritty, rxvt, linux).

notifications

How Cmd.RequestAttention and Cmd.Notify reach the user. See NotificationKind.

unicode

True if the terminal claims a UTF-8 locale.

Attributes

Companion
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all

Members list

Value members

Inherited methods

def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product