Key Parsing

Parse

k, err := keybind.Parse("ctrl+shift+a")
// k.Ctrl  = true
// k.Shift = true
// k.Base  = "a"
// k.String() = "ctrl+shift+a"

Parse validates and normalizes a key string. It returns ErrEmptyKey for an empty input and ErrUnknownKey for an unrecognized base or modifier.

MustParse

// Panics on error — for package-level vars and test helpers.
var quitKey = keybind.MustParse("ctrl+c")

The Key type

type Key struct {
    Ctrl  bool
    Alt   bool
    Shift bool
    Base  string // canonical base key name
}

Key is comparable; two Keys are == when they represent the same shortcut regardless of how the original strings were written:

a, _ := keybind.Parse("esc")
b, _ := keybind.Parse("escape")
fmt.Println(a == b) // true

Modifier order

Input order does not matter. String() always emits ctrl, alt, shift in that order:

k1, _ := keybind.Parse("shift+ctrl+a")
k2, _ := keybind.Parse("ctrl+shift+a")
fmt.Println(k1 == k2)       // true
fmt.Println(k1.String())    // "ctrl+shift+a"

Supported modifiers

Supported special keys

Any single printable character is also accepted as-is (a, A, 1, /, [, ]…). The original case is preserved so that uppercase letters (sent by some frameworks without a Shift modifier) remain distinct from lowercase.