A Swifty API for global macOS hotkeys.
Install
Add the following dependency to your Package.swift file:
.package(url: "https://github.com/jordanbaird/SwiftKeys", from: "0.0.5")
Usage
Read the full documentation here
Start by creating an instance of KeyEvent. Then, use it to initialize a KeyRecorder.
let event = KeyEvent(name: "SomeEvent")
let recorder = KeyRecorder(keyEvent: event)
The recorder and the event will stay synchronized with each other, so when the user records a new key combination, the event will update to the new value. You can also observe the event and perform actions on both key-up and key-down.
event.observe(.keyUp) {
print("UP")
}
event.observe(.keyDown) {
print("DOWN")
}
For improved type safety, you can create hard-coded key event names that can be referenced across your app.
extension KeyEvent.Name {
static let showPreferences = Self("ShowPreferences")
}
let event = KeyEvent(name: .showPreferences)
Key events are automatically stored in the UserDefaults system, using their names as keys. You can provide a custom prefix that will be combined with each name to create the keys.
extension KeyEvent.Name.Prefix {
public override var sharedPrefix: Self {
Self("SK")
}
}
In the example above, the name "ShowPreferences" would become "SKShowPreferences" when used as a defaults key.
The following pseudo-code is what a typical view controller that utilizes SwiftKeys might look like:
import SwiftKeys
class ViewController: NSViewController {
let event = KeyEvent(name: "SomeEvent")
let recorder = KeyRecorder(keyEvent: event)
override func viewDidLoad() {
super.viewDidLoad()
view.addSubview(recorder)
event.observe(.keyUp) {
print("UP")
}
event.observe(.keyDown) {
print("DOWN")
}
}
}
License
SwiftKeys is licensed under the MIT license.
3 Feb 10, 2022
16 Sep 8, 2022
0 Jan 10, 2022
29 Jan 29, 2022
2 Jul 21, 2022
3 May 25, 2022
173 Dec 30, 2022
53 Dec 16, 2022
0 Nov 2, 2021
1.1k Dec 29, 2022
182 Dec 1, 2022
464 Oct 31, 2022
0 Oct 30, 2021
0 Nov 12, 2021
5 Sep 22, 2022
0 Nov 6, 2022
3 Aug 11, 2022
3 Aug 18, 2022
4.7k Jan 9, 2023
27 May 12, 2022
0 Oct 30, 2021
0 Dec 30, 2021
0 Feb 2, 2022
3 Dec 7, 2022
3 Aug 23, 2022
1.4k Dec 26, 2022
15.4k Jan 6, 2023