help

package
v0.10.3 Latest Latest
Warning

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

Go to latest
Published: Apr 17, 2026 License: MIT Imports: 14 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func BindingLabel added in v0.10.3

func BindingLabel(binding config.BindingConfig) string

func MarkOverriddenKeys added in v0.10.3

func MarkOverriddenKeys(groups []ScopeGroup)

MarkOverriddenKeys marks entries in outer groups as overridden when an inner group binds the same key label.

func NormalizeDisplayKey added in v0.10.3

func NormalizeDisplayKey(key string) string

Types

type Entry added in v0.10.3

type Entry struct {
	Label      string
	Desc       string
	Overridden bool
}

Entry is a status-help key entry rendered as "key description".

func BuildFromBindings added in v0.10.3

func BuildFromBindings(
	scope keybindings.ScopeName,
	bindings []config.BindingConfig,
) []Entry

BuildFromBindings returns short-help entries for the given scope.

func BuildFromContinuations added in v0.10.3

func BuildFromContinuations(continuations []dispatch.Continuation) []Entry

BuildFromContinuations returns sequence continuation entries, sorted for stable display.

func FlatEntries added in v0.10.3

func FlatEntries(groups []ScopeGroup) []Entry

FlatEntries returns all entries from a slice of groups in order.

type Model

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

func New

func New() *Model

func (*Model) HandleIntent added in v0.10.3

func (m *Model) HandleIntent(intent intents.Intent) (tea.Cmd, bool)

func (*Model) Init

func (m *Model) Init() tea.Cmd

func (*Model) IsEditing

func (m *Model) IsEditing() bool

func (*Model) IsFocused

func (m *Model) IsFocused() bool

func (*Model) Scopes added in v0.10.3

func (m *Model) Scopes() []dispatch.Scope

func (*Model) Update

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

func (*Model) ViewRect

func (m *Model) ViewRect(dl *render.DisplayContext, box layout.Box)

type ScopeGroup added in v0.10.3

type ScopeGroup struct {
	Name    string
	Entries []Entry
}

ScopeGroup is a named group of help entries for a single scope.

func BuildGroupedFromBindings added in v0.10.3

func BuildGroupedFromBindings(
	scopes []keybindings.ScopeName,
	bindings []config.BindingConfig,
) []ScopeGroup

BuildGroupedFromBindings returns help entries grouped by scope.

Jump to

Keyboard shortcuts

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