92 lines
3.6 KiB
Markdown
92 lines
3.6 KiB
Markdown
[](http://creativecommons.org/licenses/by/4.0/)
|
|
|
|
|
|
|
|
[](https://cocoapods.org/pods/ShortcutRecorder)
|
|
[](https://github.com/Carthage/Carthage)
|
|
|
|
[](https://codecov.io/gh/Kentzo/ShortcutRecorder)
|
|
[](https://travis-ci.org/Kentzo/ShortcutRecorder)
|
|
|
|
# ShortcutRecorder
|
|
|
|
|
|
|
|
The best control to record shortcuts on macOS
|
|
|
|
- Objective-C framework developed with Swift in mind
|
|
- Easily stylable
|
|
- Translated into 22 languages
|
|
- Supports macOS Accessibility
|
|
- Thoroughly documented and tested
|
|
- Global and Local shortcuts for both key up and key down actions
|
|
- Mac App Store approved
|
|
- End-to-end Interface Builder integration
|
|
|
|
## What is inside
|
|
|
|
The framework comes with:
|
|
- `SRRecorderControl` to render and capture user input
|
|
- `SRRecorderControlStyle` for custom styling
|
|
- `SRShortcut` that represents a shortcut model
|
|
- `SRGlobalShortcutMonitor` to turn the shortcut into an action by registering a global hot key
|
|
- `SRLocalShortcutMonitor` for manual handling in the responder chain and `NSEvent` monitors
|
|
- `SRShortcutController` for smooth Cocoa Bindings and seamless Interface Builder integration
|
|
- `SRShortcutValidator` to check validity of the shortcut against Cocoa key equivalents and global hot keys
|
|
- `NSValueTransformer` and `NSFormatter` subclasses for custom alternations
|
|
|
|
```swift
|
|
import ShortcutRecorder
|
|
|
|
let defaults = NSUserDefaultsController.shared
|
|
let keyPath = "values.shortcut"
|
|
let options = [NSBindingOption.valueTransformerName: .keyedUnarchiveFromDataTransformerName]
|
|
|
|
let beepAction = ShortcutAction(keyPath: keyPath, of: defaults) { _ in
|
|
NSSound.beep()
|
|
return true
|
|
}
|
|
GlobalShortcutMonitor.shared.addAction(beepAction, forKeyEvent: .down)
|
|
|
|
let recorder = RecorderControl()
|
|
recorder.bind(.value, to: defaults, withKeyPath: keyPath, options: options)
|
|
|
|
recorder.objectValue = Shortcut(keyEquivalent: "⇧⌘A")
|
|
```
|
|
|
|
## Integration
|
|
|
|
The framework supports [module maps](https://clang.llvm.org/docs/Modules.html), explicit linking is not required: simply `import ShortcutRecorder` / `#import <ShortcutRecorder/ShortcutRecorder.h>`
|
|
|
|
### CocoaPods
|
|
|
|
pod 'ShortcutRecorder', '~> 3.1'
|
|
|
|
### Carthage
|
|
|
|
github "Kentzo/ShortcutRecorder" ~> 3.1
|
|
|
|
Prebuilt frameworks are available.
|
|
|
|
### Git Submodule
|
|
|
|
Add the submodule:
|
|
|
|
git submodule add git://github.com/Kentzo/ShortcutRecorder.git
|
|
|
|
Then drag'n'drop into Xcode workspace of your project.
|
|
|
|
## Next Steps
|
|
|
|
- The Documentation playground covers all parts of the framework (see in Xcode)
|
|
- The Inspector app is useful during development of custom styles
|
|
- Read about [Styling](https://github.com/Kentzo/ShortcutRecorder/wiki/Styling) and special notes regarding [Cocoa's Key Equivalents](https://github.com/Kentzo/ShortcutRecorder/wiki/Cocoa-Key-Equivalents).
|
|
|
|
## Questions
|
|
|
|
Still have questions? [Create an issue](https://github.com/Kentzo/ShortcutRecorder/issues/new).
|
|
|
|
## Paid Support
|
|
|
|
Paid support is available for custom alterations, help with integration and general advice regarding Cocoa development.
|