terminal.lua

• Index

Contents

• Functions
• Sequences

Modules

• terminal
• terminal.clear
• terminal.cursor
• terminal.cursor.position
• terminal.cursor.position.stack
• terminal.cursor.shape
• terminal.cursor.shape.stack
• terminal.cursor.visible
• terminal.cursor.visible.stack
• terminal.draw
• terminal.draw.line
• terminal.input
• terminal.input.keymap
• terminal.output
• terminal.progress
• terminal.scroll
• terminal.scroll.stack
• terminal.text
• terminal.text.color
• terminal.text.stack
• terminal.text.width
• terminal.utils

Classes

• EditLine
• Sequence
• cli.Prompt
• cli.Select
• ui.Panel
• ui.panel.Bar
• ui.panel.KeyBar
• ui.panel.Screen
• ui.panel.Set
• ui.panel.TabStrip
• ui.panel.Text

Topics

• 1. Introduction
• 2. Terminal handling
• 3. Text handling
• CHANGELOG
• CONTRIBUTING
• MIT License

Examples

• async.lua
• colors.lua
• cow.lua
• headers.lua
• keymap.lua
• panel.lua
• progress.lua
• prompt-copas.lua
• prompt.lua
• screen.lua
• sequence.lua
• tabstrip.lua
• testscreen.lua
• text_panel.lua

Module terminal.draw.line

Module for drawing lines.

Provides functions to create lines on a terminal screen.

Functions

horizontal (n[, char="─"])	Draws a horizontal line and writes it to the terminal.
title (title, width[, char="─"[, pre=""[, post=""[, type="right"[, title_attr]]]]])	Draws a horizontal line with a title centered in it and writes it to the terminal.
vertical (n[, char="│"[, lastcolumn]])	Draws a vertical line and writes it to the terminal.

Sequences

horizontal_seq (n[, char="─"])	Creates a sequence to draw a horizontal line without writing it to the terminal.
title_seq (width[, title=""[, char="─"[, pre=""[, post=""[, type="right"[, title_attr]]]]]])	Creates a sequence to draw a horizontal line with a title centered in it without writing it to the terminal.
vertical_seq (n[, char="│"[, lastcolumn]])	Creates a sequence to draw a vertical line without writing it to the terminal.

Functions

Methods

horizontal (n[, char="─"])

Draws a horizontal line and writes it to the terminal. Line is drawn left to right. Returned sequence might be shorter than requested if the character is a multi-byte character and the number of columns is not a multiple of the character width.

Parameters:

• n number number of columns to draw
• char string the character to draw (default "─")

Returns:

true

title (title, width[, char="─"[, pre=""[, post=""[, type="right"[, title_attr]]]]])

Draws a horizontal line with a title centered in it and writes it to the terminal. Line is drawn left to right. If the width is too small for the title, the title is truncated with "trailing "...". If less than 4 characters are available for the title, the title is omitted alltogether.

Parameters:

• title string the title to draw
• width number the total width of the line in columns
• char string the line-character to use (default "─")
• pre string the prefix for the title, eg. "┤ " (default "")
• post string the postfix for the title, eg. " ├" (default "")
• type string the type of truncation to apply, either "left", "right", or "drop", see utils.truncate_ellipsis for details (default "right")
• title_attr table table of attributes for the title, eg. { fg = "red", bg = "blue" } (optional)

Returns:

true

vertical (n[, char="│"[, lastcolumn]])

Draws a vertical line and writes it to the terminal. Line is drawn top to bottom. Cursor is left to the right of the last character (so not below it).

Parameters:

• n number number of rows/lines to draw
• char string the character to draw (default "│")
• lastcolumn boolean whether to draw the last column of the terminal (optional)

Returns:

true

Sequences

horizontal_seq (n[, char="─"])

Creates a sequence to draw a horizontal line without writing it to the terminal. Line is drawn left to right. Returned sequence might be shorter than requested if the character is a multi-byte character and the number of columns is not a multiple of the character width.

Parameters:

• n number number of columns to draw
• char string the character to draw (default "─")

Returns:

string ansi sequence to write to the terminal

title_seq (width[, title=""[, char="─"[, pre=""[, post=""[, type="right"[, title_attr]]]]]])

Creates a sequence to draw a horizontal line with a title centered in it without writing it to the terminal. Line is drawn left to right. If the width is too small for the title, the title is truncated. If less than 4 characters are available for the title, the title is omitted alltogether.

Parameters:

• width number the total width of the line in columns
• title string the title to draw (if empty or nil, only the line is drawn) (default "")
• char string the line-character to use (default "─")
• pre string the prefix for the title, eg. "┤ " (default "")
• post string the postfix for the title, eg. " ├" (default "")
• type string the type of truncation to apply, either "left", "right", or "drop", see utils.truncate_ellipsis for details (default "right")
• title_attr table table of attributes for the title, eg. { fg = "red", bg = "blue" } (optional)

Returns:

Sequence or string The sequence to write to the terminal

vertical_seq (n[, char="│"[, lastcolumn]])

Creates a sequence to draw a vertical line without writing it to the terminal. Line is drawn top to bottom. Cursor is left to the right of the last character (so not below it).

Parameters:

• n number number of rows/lines to draw
• char string the character to draw (default "│")
• lastcolumn boolean whether to draw the last column of the terminal (optional)

Returns:

string ansi sequence to write to the terminal