Repolode
sindresorhus

sindresorhus/KeyboardShortcuts

macOSアプリに、ユーザーがカスタマイズできるグローバルキーボードショートカットと、すぐに使える録画UIを追加できるSwiftパッケージです。

スター
2,736
フォーク
253
未解決の Issue
3
最終コミット
2 か月前

これは何?

KeyboardShortcutsは、ユーザーが変更できるグローバルキーボードショートカットを必要とするmacOSアプリ向けのSwiftパッケージです。名前付きショートカットを一度定義し、設定画面にSwiftUIまたはCocoaのレコーダービューを配置して、キーの押下または解放イベントのハンドラーを登録します。選択されたショートカットはUserDefaultsに保存され、システムやアプリのメインメニューで使用中の組み合わせが指定された場合はユーザーに警告します。

サンドボックスに対応しており、Mac App Storeでも利用できます。また、権限ダイアログは表示されません。録画したショートカットをNSMenuItemに表示するヘルパー、修飾キーのフラグを記号に変換する機能、ハードコードされたショートカットの監視機能、macOS 13以降でキーを押し続けている間アクションを繰り返す機能も含まれています。

macOS 10.15以降に対応し、Swift Package Managerでインストールできます。制限事項として、サンドボックス化されたアプリではメディアキーをサポートせず、標準APIからCaps Lockキーを監視する方法もありません。

主な機能

  • 01ショートカットを記録するSwiftUIのRecorderビューとCocoaのRecorderCocoaビューを提供します。
  • 02ユーザーが選択したショートカットをUserDefaultsに自動保存します。
  • 03システムショートカットやアプリのメインメニューとの競合をユーザーに警告します。
  • 04キーの押下イベントと解放イベントの監視に対応しています。
  • 05記録したショートカットをNSMenuItemに設定できます。
  • 06Swift Package Managerでインストールできます。

ユースケース

  • メニューバーユーティリティに、ユーザーが設定できるグローバルホットキーを追加する。
  • macOSアプリの環境設定ウィンドウで、ショートカットをユーザーがカスタマイズできるようにする。
  • ユーザーが記録し、独自のストレージに保存できるアプリ内ショートカットを追加する。

クイックスタート

  1. 1

    リポジトリ URL を使い、Xcode の Swift Package Manager タブからパッケージを追加します

  2. 2

    ショートカット名を登録してから、設定画面に Recorder ビューを追加します

  3. 3

    onKeyUp または onKeyDown でショートカットを検出します

使う前に知っておきたいこと

  • macOS 10.15 以降でのみ動作するため、他のプラットフォームでは使用できません。
  • グローバルショートカットは Apple が置き換えていない Carbon API を使用しており、サンドボックス化されたアプリではメディアキーをサポートしていません。

収録されている特集

トピック

よくある質問

KeyboardShortcuts とは?
macOSアプリに、ユーザーがカスタマイズできるグローバルキーボードショートカットと、すぐに使える録画UIを追加できるSwiftパッケージです。 KeyboardShortcutsは、ユーザーが変更できるグローバルキーボードショートカットを必要とするmacOSアプリ向けのSwiftパッケージです。名前付きショートカットを一度定義し、設定画面にSwiftUIまたはCocoaのレコーダービューを配置して、キーの押下または解放イベントのハンドラーを登録します。選択されたショートカットはUserDefaultsに保存され、システムやアプリのメインメニューで使用中の組み合わせが指定された場合はユーザーに警告します。
KeyboardShortcuts は無料で使えますか?ライセンスは?
KeyboardShortcuts は MIT ライセンスのオープンソースです。商用製品で使う前にライセンス条件を確認してください。
KeyboardShortcuts は今もメンテナンスされていますか?
半年以内に更新あり。KeyboardShortcuts の最終コミットは 2026年9月11日 です。
KeyboardShortcuts は何に使えますか?
メニューバーユーティリティに、ユーザーが設定できるグローバルホットキーを追加する。 macOSアプリの環境設定ウィンドウで、ショートカットをユーザーがカスタマイズできるようにする。 ユーザーが記録し、独自のストレージに保存できるアプリ内ショートカットを追加する。
KeyboardShortcuts のインストール方法は?
リポジトリ URL を使い、Xcode の Swift Package Manager タブからパッケージを追加します ショートカット名を登録してから、設定画面に Recorder ビューを追加します onKeyUp または onKeyDown でショートカットを検出します
KeyboardShortcuts はどこで入手できますか?
ソースコードとインストール手順は GitHub にあります:https://github.com/sindresorhus/KeyboardShortcuts

概要はプロジェクトの README をもとに AI が生成しています。GitHub の数値は毎日更新されます。

関連プロジェクト