core library
Classes
- AltInputHandler
- A TerminalInputHandler that translates alt + key events into escape sequences. For example, alt + a becomes ^[a.
- Buffer
- BufferLine
- BufferRange
- BufferRangeBlock
- BufferRangeLine
- BufferSegment
- A BufferSegment represents a range within a line.
- CascadeInputHandler
- A TerminalInputHandler that chains multiple handlers together. If any handler returns a non-null value, it is returned. Otherwise, null is returned.
- CascadeMouseHandler
- CellAnchor
- A handle to a cell in a BufferLine that can be used to track the location of the cell. Anchors are guaranteed to be stable, retaining their relative position to each other after mutations to the buffer.
- CellAttr
- CellColor
- CellContent
- CellData
- CellFlags
- CellOffset
- ClickMouseHandler
- CtrlInputHandler
- A TerminalInputHandler that translates ctrl + key events into escape sequences. For example, ctrl + a becomes ^A.
- CursorPosition
- CursorStyle
- EscapeHandler
- EscapeParser
- EscapeParser translates control characters and escape sequences into function calls that the terminal can handle.
- KeytabInputHandler
-
A TerminalInputHandler that translates key events according to a keytab
file. If no keytab is provided,
Keytab.defaultKeytab
is used. - NamedColor
- Terminal
- Terminal is an interface to interact with command line applications. It translates escape sequences from the application into updates to the buffer and events such as onTitleChange or onBell, as well as translating user input into escape sequences that the application can understand.
- TerminalInputHandler
- TerminalInputHandler contains the logic for translating a TerminalKeyboardEvent into escape sequences that can be recognized by the terminal.
- TerminalKeyboardEvent
- The key event received from the keyboard, along with the state of the modifier keys and state of the terminal. Typically consumed by the TerminalInputHandler to produce a escape sequence that can be recognized by the terminal.
- TerminalMouseEvent
- TerminalMouseHandler
- TerminalState
- UpDownMouseHandler
Enums
Constants
- defaultInputHandler → const CascadeInputHandler
- The default input handler for the terminal. That is composed of a KeytabInputHandler, a CtrlInputHandler, and a AltInputHandler.
- defaultMouseHandler → const CascadeMouseHandler