help

package
v1.23.1 Latest Latest
Warning

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

Go to latest
Published: Sep 13, 2026 License: MIT Imports: 2 Imported by: 0

Documentation

Overview

Package help renders the scrollable keyboard/command reference overlay.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Model

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

Model is a simple scrollable text viewer for the help screen.

func New

func New() Model

func (*Model) SetContent

func (m *Model) SetContent(s string)

SetContent replaces the help text and scrolls back to the top.

func (*Model) SetSize

func (m *Model) SetSize(width, height int)

SetSize resizes the viewport and re-applies the current content.

func (Model) Update

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

func (Model) View

func (m Model) View() string

Jump to

Keyboard shortcuts

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