help

Documentation

Overview

Package help renders the full-screen keybinding help overlay.

The layout is a responsive grid: on wide terminals the category groups flow into two columns side-by-side; on narrow terminals they stack into a single column. Each row renders the keybinding as a chip on the left and the action name to its right — reading order matches how a user actually thinks ("what does ^p do?" → scan keys, not names).

Index

• type CloseHelpMsg
• type Model
  • func New(reg *actions.Registry, t *theme.Theme) *Model
  • func (m *Model) Open()
  • func (m *Model) Update(msg tea.Msg) (*Model, tea.Cmd)
  • func (m *Model) View() string

Types

type CloseHelpMsg

type CloseHelpMsg struct{}

CloseHelpMsg is emitted when the help overlay is dismissed.

type Model

type Model struct {
	Width  int
	Height int
	Theme  *theme.Theme
	// contains filtered or unexported fields
}

Model is the Bubbletea model for the keybinding help overlay.

func New

func New(reg *actions.Registry, t *theme.Theme) *Model

New creates a new help overlay model.

func (*Model) Open

func (m *Model) Open()

Open builds the help content from the registry and resets the viewport to the top.

func (*Model) Update

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

Update handles key events for the help overlay.

func (*Model) View

func (m *Model) View() string

View renders the full-screen help overlay.