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.Screen
• 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
• testscreen.lua
• text_panel.lua

Module terminal.cursor.shape

Terminal cursor shape module.

Provides utilities for cursor shape handling in terminals.

Functions

set (shape)

Sets the cursor shape and writes it to the terminal.

Sequences

set_seq (shape)

Returns the ansi sequence for a cursor shape without writing it to the terminal.

Functions

set (shape)

Sets the cursor shape and writes it to the terminal.

Parameters:

• shape string the shape to set, one of the keys "block", "block_blink", "underline", "underline_blink", "bar", "bar_blink"

Returns:

true

Sequences

set_seq (shape)

Returns the ansi sequence for a cursor shape without writing it to the terminal.

Parameters:

• shape string the shape to get, one of the keys "block", "block_blink", "underline", "underline_blink", "bar", "bar_blink"

Returns:

string ansi sequence to write to the terminal