keymap

package
v0.2.0 Latest Latest
Warning

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

Go to latest
Published: Oct 23, 2025 License: MIT Imports: 2 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var Accept = key.NewBinding(
	key.WithKeys("y", "Y"),
	key.WithHelp("y", "yes"),
)
View Source
var Back = key.NewBinding(
	key.WithKeys("esc"),
	key.WithHelp("esc", "back"),
)
View Source
var Cancel = key.NewBinding(
	key.WithKeys("esc"),
	key.WithHelp("esc", "cancel"),
)
View Source
var ChangeFocused = key.NewBinding(
	key.WithKeys("tab"),
	key.WithHelp("tab", "change focus between editor and list"),
)
View Source
var Continue = key.NewBinding(
	key.WithKeys("alt+enter", "ctrl+s"),
	key.WithHelp("alt+enter / ctrl+s", "continue"),
)
View Source
var DefaultKeyMap = Model{
	Up:     Up,
	Down:   Down,
	Left:   Left,
	Right:  Right,
	Search: Search,
	Back:   Back,
	Help:   Help,
	Quit:   Quit,
}
View Source
var Down = key.NewBinding(
	key.WithKeys("down", "j"),
	key.WithHelp("↓ / j", "down"),
)
View Source
var ExitSearch = key.NewBinding(
	key.WithKeys("esc"),
	key.WithHelp("esc", "exit search"),
)
View Source
var ExternalEditor = key.NewBinding(
	key.WithKeys("ctrl+e"),
	key.WithHelp("ctrl+e", "open in external editor"),
)
View Source
var ForceQuit = key.NewBinding(
	key.WithKeys("ctrl+c"),
	key.WithHelp("ctrl+c", "quit"),
)
View Source
var FullScreen = key.NewBinding(
	key.WithKeys("F"),
	key.WithHelp("F", "toggle full screen"),
)
View Source
var Help = key.NewBinding(
	key.WithKeys("?"),
	key.WithHelp("?", "help"),
)
View Source
var Left = key.NewBinding(
	key.WithKeys("left", "h"),
	key.WithHelp("← / h", "left"),
)
View Source
var ListKeyMap = Model{
	Up:     Up,
	Down:   Down,
	Select: FullScreen,
}
View Source
var New = key.NewBinding(
	key.WithKeys("ctrl+n"),
	key.WithHelp("ctrl+n", "new note"),
)
View Source
var NewLine = key.NewBinding(
	key.WithKeys("enter"),
	key.WithHelp("enter", "new line"),
)
View Source
var Quit = key.NewBinding(
	key.WithKeys("ctrl+c"),
	key.WithHelp("ctrl+c", "quit"),
)
View Source
var QuitForm = key.NewBinding(
	key.WithKeys("ctrl+c", "esc"),
	key.WithHelp("ctrl+c / esc", "quit"),
)
View Source
var Reject = key.NewBinding(
	key.WithKeys("n", "N"),
	key.WithHelp("n", "no"),
)
View Source
var Right = key.NewBinding(
	key.WithKeys("right", "l"),
	key.WithHelp("→ / l", "right"),
)
View Source
var Save = key.NewBinding(
	key.WithKeys("enter"),
	key.WithHelp("enter", "save"),
)
View Source
var Search = key.NewBinding(
	key.WithKeys("/"),
	key.WithHelp("/", "search"),
)
View Source
var SearchKeyMap = Model{
	ExitSearch: ExitSearch,
	Quit:       Quit,
}
View Source
var ToggleEdit = key.NewBinding(
	key.WithKeys("E"),
	key.WithHelp("E", "toggle edit"),
)
View Source
var Up = key.NewBinding(
	key.WithKeys("up", "k"),
	key.WithHelp("↑ / k", "up"),
)

Functions

func ReplaceBinding

func ReplaceBinding(bindings []key.Binding, newBinding key.Binding) []key.Binding

Types

type Model

type Model struct {
	Up         key.Binding
	Down       key.Binding
	Left       key.Binding
	Right      key.Binding
	Help       key.Binding
	Quit       key.Binding
	Back       key.Binding
	Select     key.Binding
	Search     key.Binding
	ExitSearch key.Binding
	Copy       key.Binding

	ShortHelpBindings []key.Binding
	FullHelpBindings  []key.Binding
}

func CombineKeys

func CombineKeys(a, b Model) Model

func (Model) FullHelp

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

func (Model) ShortHelp

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

Jump to

Keyboard shortcuts

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