Swiftpack.co -  Clipy/Magnet as Swift Package
Swiftpack.co is a collection of thousands of indexed Swift packages. Search packages.
Clipy/Magnet
Customize global hotkeys in macOS.
.package(url: "https://github.com/Clipy/Magnet.git", from: "v3.3.0")

Magnet

CI Release version License: MIT Carthage compatible Version Platform SPM supported

Customize global hotkeys in macOS. Supports usual hotkey and double tap hotkey like Alfred.app.

Also supports sandbox application.

Usage

CocoaPods

pod 'Magnet'

Carthage

github "Clipy/Magnet"

Upgrading from Magnet v2.x to v3.x

See Upgrading from Magnet v2.x

Example

Register Normal hotkey

Add ⌘ + Control + B hotkey.

if let keyCombo = KeyCombo(key: .b, cocoaModifiers: [.command, .control]]) {
   let hotKey = HotKey(identifier: "CommandControlB", keyCombo: keyCombo, target: self, action: #selector())
   hotKey.register() // or HotKeyCenter.shared.register(with: hotKey)
}

Or you can use closures.

if let keyCombo = KeyCombo(key: .b, cocoaModifiers: [.command, .control]) {
    let hotKey = HotKey(identifier: "CommandControlB", keyCombo: keyCombo) { hotKey in
        // Called when ⌘ + Control + B is pressed
    }
    hotKey.register()
}        

Register Double tap hotkey

Add ⌘ double tap hotkey.

if let keyCombo = KeyCombo(doubledCocoaModifiers: .command) {
   let hotKey = HotKey(identifier: "CommandDoubleTap", keyCombo: keyCombo, target: self, action: #selector())
   hotKey.register() // or HotKeyCenter.shared.register(with: hotKey)
}

Add Control double tap hotkey.

if let keyCombo = KeyCombo(doubledCarbonModifiers: controlKey) {
   let hotKey = HotKey(identifier: "ControlDoubleTap", keyCombo: keyCombo, target: self, action: #selector())
   hotKey.register() // or HotKeyCenter.shared.register(with: hotKey)
}

Support modifiers

Double tap hotkey only support following modifiers.

  • Command Key
    • NSEventModifierFlags.command or cmdKey
  • Shift Key
    • NSEventModifierFlags.shift or shiftKey
  • Option Key
    • NSEventModifierFlags.option or optionKey
  • Control Key
    • NSEventModifierFlags.control or controlKey

Unregister hotkeys

HotKeyCenter.shared.unregisterAll()

or

HotKeyCenter.shared.unregisterHotKey(with: "identifier")

or

let hotKey = HotKey(identifier: "identifier", keyCombo: KeyCombo, target: self, action: #selector())
hotKey.unregister() // or HotKeyCenter.shared.unregister(with: hotKey)

Dependencies

How to Build

  1. Move to the project root directory
  2. Install dependency library with carthage or git submodule
  3. carthage checkout --use-submodules or git submodule update --init --recursive
  4. Open Magnet.xcworkspace on Xcode.
  5. build.

GitHub

link
Stars: 334
Last commit: 5 weeks ago

Ad: Job Offers

iOS Software Engineer @ Perry Street Software
Perry Street Software is Jack’d and SCRUFF. We are two of the world’s largest gay, bi, trans and queer social dating apps on iOS and Android. Our brands reach more than 20 million members worldwide so members can connect, meet and express themselves on a platform that prioritizes privacy and security. We invest heavily into SwiftUI and using Swift Packages to modularize the codebase.

Release Notes

v3.3.0
5 weeks ago

Breaking Changes

Enhancements

  • Initialize NSEvent.ModifierFlags from carbon modifiers. ( #63 )
  • Add public extension NSEvent.keyCombo. ( #67 )
  • Replace deprecated converter calls. ( #71 )

Bugfixes

  • Fix dependencies target version. ( #76 )

Thanks @DivineDominion for contributing!

Swiftpack is being maintained by Petr Pavlik | @ptrpavlik | @swiftpackco | API