constants

Documentation

Index

• Variables
• type KeyMap
  • func (k KeyMap) FullHelp() [][]key.Binding
  • func (k KeyMap) ShortHelp() []key.Binding

Variables

var Keys = KeyMap{

	Generic: key.NewBinding(
		key.WithHelp("↑/↓", "navigate")),
	Help: key.NewBinding(
		key.WithHelp("?", "help")),
	Quit: key.NewBinding(
		key.WithKeys("q", "ctrl+c"),
		key.WithHelp("q", "quit")),
	Catchup: key.NewBinding(
		key.WithKeys("f"),
		key.WithHelp("f", "start fast catchup")),
	AbortCatchup: key.NewBinding(
		key.WithKeys("a"),
		key.WithHelp("a", "abort catchup")),
	Section: key.NewBinding(
		key.WithKeys("tab"),
		key.WithHelp("tab", "section")),
	Forward: key.NewBinding(
		key.WithKeys("enter", "→"),
		key.WithHelp("enter", "forwards")),
	Back: key.NewBinding(
		key.WithKeys("esc", "←"),
		key.WithHelp("esc", "backwards")),
}

Keys is a global for accessing the KeyMap.

Types

type KeyMap

type KeyMap struct {
	Generic      key.Binding
	Quit         key.Binding
	Catchup      key.Binding
	AbortCatchup key.Binding
	Section      key.Binding
	Forward      key.Binding
	Back         key.Binding
	Help         key.Binding
}

KeyMap contains references to all the key bindings.

func (KeyMap) FullHelp

func (k KeyMap) FullHelp() [][]key.Binding

FullHelp implements the KeyMap interface.

func (KeyMap) ShortHelp

func (k KeyMap) ShortHelp() []key.Binding

ShortHelp implements the KeyMap interface.