KeyboardShortcuts

Remove all handlers receiving keyboard shortcuts events.

This can be used to reset the handlers before re-creating them to avoid having multiple handlers for the same shortcut.

Disable a keyboard shortcut.

Enable a disabled keyboard shortcut.

Reset the keyboard shortcut for one or more names.

If the Name has a default shortcut, it will reset to that.

import SwiftUI
import KeyboardShortcuts

struct PreferencesView: View {
    var body: some View {
        VStack {
            // …
            Button("Reset All") {
                KeyboardShortcuts.reset(
                    .toggleUnicornMode,
                    .showRainbow
                )
            }
        }
    }
}

Reset the keyboard shortcut for one or more names.

If the Name has a default shortcut, it will reset to that.

import SwiftUI
import KeyboardShortcuts

struct PreferencesView: View {
    var body: some View {
        VStack {
            // …
            Button("Reset All") {
                KeyboardShortcuts.reset(
                    .toggleUnicornMode,
                    .showRainbow
                )
            }
        }
    }
}

Set the keyboard shortcut for a name.

Setting it to nil removes the shortcut, even if the Name has a default shortcut defined. Use .reset() if you want it to respect the default shortcut.

You would usually not need this as the user would be the one setting the shortcut in a preferences user-interface, but it can be useful when, for example, migrating from a different keyboard shortcuts package.

Get the keyboard shortcut for a name.

Listen to the keyboard shortcut with the given name being pressed.

You can register multiple listeners.

You can safely call this even if the user has not yet set a keyboard shortcut. It will just be inactive until they do.

import Cocoa
import KeyboardShortcuts

@main
final class AppDelegate: NSObject, NSApplicationDelegate {
    func applicationDidFinishLaunching(_ notification: Notification) {
        KeyboardShortcuts.onKeyDown(for: .toggleUnicornMode) { [self] in
            isUnicornMode.toggle()
        }
    }
}

Listen to the keyboard shortcut with the given name being pressed.

You can register multiple listeners.

You can safely call this even if the user has not yet set a keyboard shortcut. It will just be inactive until they do.

import Cocoa
import KeyboardShortcuts

@main
final class AppDelegate: NSObject, NSApplicationDelegate {
    func applicationDidFinishLaunching(_ notification: Notification) {
        KeyboardShortcuts.onKeyUp(for: .toggleUnicornMode) { [self] in
            isUnicornMode.toggle()
        }
    }
}

Represents a key on the keyboard.

The strongly-typed name of the keyboard shortcut.

After registering it, you can use it in, for example, KeyboardShortcut.Recorder and KeyboardShortcut.onKeyUp().

import KeyboardShortcuts

extension KeyboardShortcuts.Name {
    static let toggleUnicornMode = Self("toggleUnicornMode")
}

A SwiftUI View that lets the user record a keyboard shortcut.

You would usually put this in your preferences window.

It automatically prevents choosing a keyboard shortcut that is already taken by the system or by the app’s main menu by showing a user-friendly alert to the user.

It takes care of storing the keyboard shortcut in UserDefaults for you.

import SwiftUI
import KeyboardShortcuts

struct PreferencesView: View {
    var body: some View {
        HStack {
            Text("Toggle Unicorn Mode:")
            KeyboardShortcuts.Recorder(for: .toggleUnicornMode)
        }
    }
}

A NSView that lets the user record a keyboard shortcut.

You would usually put this in your preferences window.

It automatically prevents choosing a keyboard shortcut that is already taken by the system or by the app’s main menu by showing a user-friendly alert to the user.

It takes care of storing the keyboard shortcut in UserDefaults for you.

import Cocoa
import KeyboardShortcuts

final class PreferencesViewController: NSViewController {
    override func loadView() {
        view = NSView()

        let recorder = KeyboardShortcuts.RecorderCocoa(for: .toggleUnicornMode)
        view.addSubview(recorder)
    }
}

A keyboard shortcut.