hotkey

README

hotkey

cross platform hotkey package in Go

import "golang.design/x/hotkey"

Features

• Cross platform supports: macOS, Linux (X11), and Windows
• Global hotkey registration without focus on a window

API Usage

Package hotkey provides the basic facility to register a system-level hotkey so that the application can be notified if a user triggers the desired hotkey. By definition, a hotkey is a combination of modifiers and a single key, and thus register a hotkey that contains multiple keys is not supported at the moment. Furthermore, because of OS restriction, hotkey events must be handled on the main thread.

Therefore, in order to use this package properly, here is a complete example that corporates the mainthread package:

package main

import (
	"context"

	"golang.design/x/hotkey"
	"golang.design/x/mainthread"
)

// initialize mainthread facility so that hotkey can be
// properly registered to the system and handled by the
// application.
func main() { mainthread.Init(fn) }
func fn() { // Use fn as the actual main function.
	var (
		mods = []hotkey.Modifier{hotkey.ModCtrl}
		k    = hotkey.KeyS
	)

	// Register a desired hotkey.
	hk, err := hotkey.Register(mods, k)
	if err != nil {
		panic("hotkey registration failed")
	}

	// Start listen hotkey event whenever you feel it is ready.
	triggered := hk.Listen(context.Background())
	for range triggered {
		println("hotkey ctrl+s is triggered")
	}
}

Who is using this package?

The main purpose of building this package is to support the midgard project.

To know more projects, check our wiki page.

License

MIT | © 2021 The golang.design Initiative Authors, written by Changkun Ou.