hotkey

package module

Go to main page

Versions in this module

v0

v0.10.0

Sep 6, 2026

v0.9.1

Sep 6, 2026

v0.9.0

Sep 5, 2026

Changes in this version

type Key

+ const KeyISOSection

v0.8.0

Sep 4, 2026

Changes in this version

type Key

+ func KeyForChar(ch string) (Key, bool)

+ func (k Key) Char() string

type Options

+ OnThisKeyboard bool

v0.7.0

Sep 4, 2026

Changes in this version

type Combo

+ func (c Combo) Glyphs() string

type Key

+ func (k Key) Glyph() string

v0.6.0

Aug 29, 2026

Changes in this version

+ func ResolveBare(want Combo, ladder []Modifier, reg Registrar, reserved Reserver) (Combo, Claim, error)

type Options

+ BareKey bool

v0.5.1

Aug 28, 2026

v0.5.0

Aug 27, 2026

Changes in this version

type Key

+ const KeyLeftBracket

+ const KeyRightBracket

v0.4.0

Aug 27, 2026

Changes in this version

type Key

+ const KeyEqual

+ const KeyMinus

v0.3.0

Aug 26, 2026

Changes in this version

type Key

+ func (k Key) Name() string

v0.2.0

Aug 26, 2026

Changes in this version

+ var ErrParse = errors.New("hotkey: unreadable combination")

+ func KeyNames() string

type Combo

+ func ParseCombo(s string) (Combo, error)

type Modifier

+ func ParseModifier(s string) (Modifier, error)

v0.1.0

Aug 25, 2026

Changes in this version

+ var DefaultLadder = []Modifier

+ var ErrClosed = errors.New("hotkey: hot key already released")

+ var ErrComboTaken = errors.New("hotkey: combination already taken")

+ var ErrNoCandidate = errors.New("hotkey: every candidate combination is taken")

+ var ErrNoModifier = errors.New("hotkey: a system-wide hot key needs at least one modifier")

+ var ErrUnsupported = errors.New("hotkey: unsupported on this platform (darwin only)")

+ func Resolve(want Combo, ladder []Modifier, reg Registrar, reserved Reserver) (Combo, Claim, error)

+ type Claim interface

+ Release func() error

+ type Combo struct

+ Key Key

+ Mods Modifier

+ func Candidates(want Combo, ladder []Modifier) []Combo

+ func (c Combo) Names() string

+ func (c Combo) String() string

+ func (c Combo) Valid() bool

+ type Event struct

+ At time.Time

+ Combo Combo

+ type Hotkey struct

+ func Register(want Combo, opts *Options) (*Hotkey, error)

+ func (h *Hotkey) C() <-chan Event

+ func (h *Hotkey) Close() error

+ func (h *Hotkey) Combo() Combo

+ func (h *Hotkey) Substituted() bool

+ func (h *Hotkey) Wanted() Combo

+ type Key uint16

+ const KeyA

+ const KeyB

+ const KeyC

+ const KeyD

+ const KeyDelete

+ const KeyDownArrow

+ const KeyE

+ const KeyEscape

+ const KeyF

+ const KeyF1

+ const KeyF10

+ const KeyF11

+ const KeyF12

+ const KeyF13

+ const KeyF14

+ const KeyF15

+ const KeyF2

+ const KeyF3

+ const KeyF4

+ const KeyF5

+ const KeyF6

+ const KeyF7

+ const KeyF8

+ const KeyF9

+ const KeyG

+ const KeyH

+ const KeyI

+ const KeyJ

+ const KeyK

+ const KeyL

+ const KeyLeftArrow

+ const KeyM

+ const KeyN

+ const KeyN0

+ const KeyN1

+ const KeyN2

+ const KeyN3

+ const KeyN4

+ const KeyN5

+ const KeyN6

+ const KeyN7

+ const KeyN8

+ const KeyN9

+ const KeyO

+ const KeyP

+ const KeyQ

+ const KeyR

+ const KeyReturn

+ const KeyRightArrow

+ const KeyS

+ const KeySlash

+ const KeySpace

+ const KeyT

+ const KeyTab

+ const KeyU

+ const KeyUpArrow

+ const KeyV

+ const KeyW

+ const KeyX

+ const KeyY

+ const KeyZ

+ func (k Key) String() string

+ type Modifier uint8

+ const Command

+ const Control

+ const Option

+ const Shift

+ func (m Modifier) Names() []string

+ func (m Modifier) String() string

+ type NoReserved struct

+ func (NoReserved) Reserved(Combo) (string, bool)

+ type Options struct

+ Ladder []Modifier

+ Reserved Reserver

+ type Origin int

+ const FromDefaults

+ const FromPreferences

+ func (o Origin) String() string

+ type Override struct

+ Combo Combo

+ Enabled bool

+ HasCombo bool

+ ID int

+ func ParseSymbolicHotKeys(raw map[string]any) []Override

+ type Registrar interface

+ Claim func(Combo) (Claim, error)

+ type Reserver interface

+ Reserved func(Combo) (reason string, taken bool)

+ type SystemShortcut struct

+ Combo Combo

+ Enabled bool

+ ID int

+ Name string

+ Origin Origin

+ func DefaultShortcuts() []SystemShortcut

+ func (s SystemShortcut) String() string

+ type SystemShortcuts struct

+ func LoadSystemShortcuts() (*SystemShortcuts, error)

+ func Merge(defaults []SystemShortcut, overrides []Override) *SystemShortcuts

+ func (s *SystemShortcuts) All() []SystemShortcut

+ func (s *SystemShortcuts) Describe() string

+ func (s *SystemShortcuts) Reserved(c Combo) (string, bool)

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