HotKey Documentation

To use HotKey in your Swift project via Swift Package Manager, add the following dependency to your Package.swift file:

.package(url: "https://github.com/soffes/HotKey", from: "0.2.1")

To use HotKey in your project with CocoaPods, add the following line to your Podfile:

pod 'HotKey'

To use HotKey in your project with Carthage, add the following line to your Cartfile:

github "soffes/HotKey"

Initialize a HotKey object by specifying a key and a set of modifiers. The library provides a convenience initializer that accepts a key and an array of modifiers (e.g., .command, .option, .shift, .control).

Registration and unregistration of the hot key are handled automatically based on the lifecycle of the HotKey instance.

// Setup hot key for ⌥⌘R
let hotKey = HotKey(key: .r, modifiers: [.command, .option])

Once a HotKey is initialized, you can assign closures to keyDownHandler and keyUpHandler to respond to user input. The keyDownHandler is triggered when the specified key combination is pressed.

hotKey.keyDownHandler = {
  print("Pressed at \(Date())")
}

// You can also implement keyUpHandler
hotKey.keyUpHandler = {
  print("Released")
}