hints

Documentation

Index

• type Formatter
  • func NewFormatter(registry KeyRegistry) *Formatter
  • func (f *Formatter) GetKeyHint(actionID string, actionVerb string) string
  • func (f *Formatter) GetKeyOnly(actionID string) string
• type KeyAction
• type KeyRegistry

Types

type Formatter

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

Formatter provides methods to format keybinding hints for UI display

func NewFormatter

func NewFormatter(registry KeyRegistry) *Formatter

NewFormatter creates a new key hint formatter with a registry

func (*Formatter) GetKeyHint

func (f *Formatter) GetKeyHint(actionID string, actionVerb string) string

GetKeyHint returns a formatted hint string for a given action ID Format: "Press <key> to <action>" Example: "Press ctrl+o to expand" or "Press esc to cancel"

func (*Formatter) GetKeyOnly

func (f *Formatter) GetKeyOnly(actionID string) string

GetKeyOnly returns just the key binding without "Press" or action verb Useful for inline hints like "ctrl+o"

type KeyAction

type KeyAction interface {
	GetKeys() []string
	IsEnabled() bool
}

KeyAction represents a minimal key action interface for hint formatting

type KeyRegistry

type KeyRegistry interface {
	GetAction(id string) KeyAction
}

KeyRegistry provides access to registered key actions