terminal.lua

• Index

Contents

• Functions
• Methods

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

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

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

Class cli.Prompt

Prompt input for CLI tools.

This module provides a simple way to read line input from the terminal. The user can confirm their choices by pressing <Enter> or cancel their choices by pressing <Esc> (when cancellable is enabled).

Features: Prompt, UTF8 support, async input, (to be added: secrets, scrolling and wrapping)

NOTE: you MUST call terminal.initialize before calling this widget's :run() method.

Usage:

local prompt = Prompt {
    prompt = "Enter something: ",
    value = "Hello, 你-好 World 🚀!",
    max_length = 62,
    -- overflow = "wrap" -- or "scroll"   -- TODO: implement
    cancellable = true,
    position = 2,
}
local result, err = prompt:run()  --> nil, "cancelled": if cancelled

Alternative short version:

local result, err = Prompt{ prompt = "What's your name: " }()

Note: ctrl-c is handled as a cancellation, just like escape (if the terminal was set up to handle ctrl-c).

Functions

cli.Prompt (opts)

Create a new Prompt instance.

Methods

cli.prompt:run ()

Starts the prompt input loop.

Functions

Methods

cli.Prompt (opts)

Create a new Prompt instance.

Parameters:

• opts Options for the prompt.
  • prompt string or EditLine The prompt text to display. (default "")
  • value string or EditLine The initial value of the prompt (truncated if too long). (default "")
  • position number The initial cursor position (in char) of the input (default at the end). (optional)
  • max_length number The maximum length of the input. (default 80)
  • word_delimiters string Word delimiters for word operations. (optional)
  • text_attr table Text attributes for the prompt (input value only). (optional)
  • wordwrap boolean Whether to wordwrap the input value. (default false)
  • cancellable boolean When true, pressing <Esc> cancels the input and run() returns nil, "cancelled". (default false)

Returns:

Prompt A new Prompt instance.

Methods

cli.prompt:run ()

Starts the prompt input loop. Calling on the instance is a short-cut to calling this method.

Returns:

1. string or nil The final input value entered by the user, or nil if the input was cancelled.
2. string The error string if cancelled; "cancelled".