Cross platform terminal library for Lua (Windows/Unix/Mac)

Modules

spec.helpers Helper functions for testing the terminal.lua library.
terminal Terminal library for Lua.
terminal.clear Module for clearing (parts of) the screen.
terminal.cursor Terminal cursor management module.
terminal.cursor.position Terminal cursor position module.
terminal.cursor.shape Terminal cursor shape module.
terminal.cursor.visible Terminal cursor visibility module.
terminal.draw Module for drawing lines and boxes.
terminal.draw.line Module for drawing lines.
terminal.input Module for getting keyboard input.
terminal.input.keymap Module to map received input to key-names.
terminal.output Module for writing output.
terminal.progress A module for progress updating.
terminal.scroll Terminal scroll module.
terminal.text Terminal text module.
terminal.text.color Terminal text color module.
terminal.text.width Module for character and string display width in terminal columns.
terminal.utils Support functions.

Classes

EditLine UTF8 based EditLine class.
Sequence Sequence class.
cli.Prompt Prompt input for CLI tools.
cli.Select A single-choice interactive menu widget for CLI tools.
ui.Canvas A canvas using Unicode Braille characters for TUI pixel graphics.
ui.CanvasViewport A viewport that maps a virtual coordinate space onto a Canvas.
ui.Panel Panel system for terminal UI layouts.
ui.TimeSeriesGraph A time-series graph drawn on a Canvas using a CanvasViewport.
ui.panel.Bar Panel bar for single-line terminal UI elements.
ui.panel.KeyBar Key bar panel for displaying keyboard shortcuts.
ui.panel.Screen Screen class for full-screen terminal applications.
ui.panel.Set Panel set for managing multiple named panels with single selection.
ui.panel.TabStrip TabStrip panel for displaying horizontal tab labels.
ui.panel.Text TextPanel class for displaying and navigating scrollable text content.

Topics

01-introduction.md
02-terminal_handling.md
03-text_handling.md
CHANGELOG.md
CONTRIBUTING.md
LICENSE.md

Examples

async.lua
canvas.lua
car_race.lua
colors.lua
cow.lua
graph.lua
headers.lua
keymap.lua
panel.lua
progress.lua
prompt-copas.lua
prompt.lua
screen.lua
select.lua
sequence.lua
tabstrip.lua
testscreen.lua
text_panel.lua
generated by LDoc 1.5.0