help

Documentation

Index

• type Model
  • func New(t theme.Theme) Model
  • func (m Model) ModalView() string
  • func (m *Model) SetSize(w, h int)
  • func (m Model) Update(msg tea.Msg) (Model, bool)
  • func (m Model) View() string

Types

type Model

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

Model is a help overlay that lists keybindings in a scrollable popup.

func New

func New(t theme.Theme) Model

New creates a new help overlay model.

func (Model) ModalView

func (m Model) ModalView() string

ModalView renders only the boxed help popup content.

func (*Model) SetSize

func (m *Model) SetSize(w, h int)

SetSize updates the overlay dimensions and rebuilds the viewport content.

func (Model) Update

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

Update handles messages — dismiss keys close, everything else scrolls.

func (Model) View

func (m Model) View() string

View renders the help overlay as a centered floating panel.