terminal.lua

• Index

Contents

• Methods

Classes

• EditLine
• Sequence
• cli.Prompt
• cli.Select
• ui.Panel
• ui.panel.Bar
• ui.panel.Screen
• 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
• 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

Class ui.panel.Screen

Screen class for full-screen terminal applications.

Manages a full-screen layout with optional header and footer panels (see ui.panel.Bar). Derives from ui.Panel.

Methods

ui.panel.screen:calculate_layout ()	Recalculate the screen layout using current terminal dimensions.
ui.panel.screen:check_resize ([update=false])	Check if the terminal has been resized and optionally update the layout.
ui.panel.screen:init (opts)	Initialize a new Screen instance.

Methods

ui.panel.screen:calculate_layout ()

Recalculate the screen layout using current terminal dimensions. Overrides ui.Panel:calculate_layout to use full screen dimensions instead of specifying them.

ui.panel.screen:check_resize ([update=false])

Check if the terminal has been resized and optionally update the layout.

Parameters:

• update boolean Whether to recalculate and redraw if resized (default false)

Returns:

boolean True if the terminal was resized

ui.panel.screen:init (opts)

Initialize a new Screen instance. Do not call this method directly, call on the class instead.

Parameters:

• opts Configuration options (see Panel:init for inherited properties)
  • header Panel Optional header panel (will be (re)named "header")
  • body Panel Required body panel (will be (re)named "body")
  • footer Panel Optional footer panel (will be (re)named "footer")
  • name string Optional name for the screen

See also:

ui.panel.Bar