helpoverlay

package
v0.6.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 24, 2026 License: MIT Imports: 12 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func New

func New(ctx keys.Context, composeFiles []string, termWidth, termHeight int) tea.Model

New builds the help overlay for the screen described by ctx (which keys are pressable), the compose-file candidates in priority order, and the terminal size for wrapping and windowing.

Types

type Model

type Model struct {
	// contains filtered or unexported fields
}

Model is the ? overlay: every key in the app, grouped by scope and rendered from keys.Catalog, so what it says is what the handlers do. Rows the user could not press in the screen it was opened from are dimmed. It also names the compose-file candidates that lost to the loaded one - the footer only has room to count them.

The catalog is more than one terminal's worth of lines once every entry gets its own row, so the content is windowed and scrolls with ↑/↓ (keys.Overlay.Navigation), and narrowable with a `/`-fuzzy filter over each entry's key and description.

func (Model) Init

func (m Model) Init() tea.Cmd

func (Model) Update

func (m Model) Update(msg tea.Msg) (tea.Model, tea.Cmd)

func (Model) View

func (m Model) View() tea.View

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL