helpbar

package
v1.13.0-rc8 Latest Latest
Warning

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

Go to latest
Published: Aug 3, 2026 License: Apache-2.0 Imports: 2 Imported by: 0

Documentation

Index

Constants

View Source
const KeyBack = "esc"

KeyBack is the canonical key for "go back / close this view".

View Source
const KeyQuit = "ctrl+q"

KeyQuit is the canonical key for "quit the application".

Variables

View Source
var EditionLabel = "Community Edition"

EditionLabel is rendered below the logo. Override in init() to customise.

View Source
var Style = lipgloss.NewStyle().
	Padding(0, 0).
	Faint(true)

Functions

func SetEditionLabel

func SetEditionLabel(label string)

Types

type HelpEntry

type HelpEntry struct {
	Key      string
	Desc     string
	Disabled bool
}

type Model

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

func New

func New(width, height int) *Model

func (*Model) SetHeight

func (m *Model) SetHeight(height int) *Model

func (*Model) SetWidth

func (m *Model) SetWidth(width int) *Model

func (*Model) View

func (m *Model) View(systemInfo string, hasError bool) string

func (*Model) WithGlobalHelp

func (m *Model) WithGlobalHelp(entries []HelpEntry) *Model

func (*Model) WithViewHelp

func (m *Model) WithViewHelp(entries []HelpEntry) *Model

Jump to

Keyboard shortcuts

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