help

Documentation

Index

• type DismissMsg
• type Model
  • func New(keys config.KeyBindings, version string, width, height int) Model
  • func (m Model) BoxSize(screenWidth, screenHeight int) (int, int)
  • func (m Model) Update(msg tea.KeyMsg) (Model, tea.Cmd)
  • func (m Model) View(th theme.Theme, screenWidth, screenHeight int) string

Types

type DismissMsg

type DismissMsg struct{}

DismissMsg is sent when the user closes help.

type Model

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

Model is the help overlay.

func New

func New(keys config.KeyBindings, version string, width, height int) Model

New creates a new help overlay.

func (Model) BoxSize

func (m Model) BoxSize(screenWidth, screenHeight int) (int, int)

BoxSize returns desired box dimensions.

func (Model) Update

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

Update handles key events.

func (Model) View

func (m Model) View(th theme.Theme, screenWidth, screenHeight int) string

View renders the help overlay.