Global Shortcut（グローバル・ショートカット）

《訳注》

Plugin 説明内容の英語表記部分について　Plugin の各章は、原文データからページ内容の一部が自動生成されているため、英語表記のままの部分があります。

API Reference

グローバルショートカットを登録します。

対応プラットフォーム

This plugin requires a Rust version of at least 1.77.2

Platform	Level	Notes
windows
linux
macos
android
ios

セットアップ

はじめに、「Global Shortcut グローバル・ショートカット」プラグインをインストールしてください。

自動で設定
手動で設定

自分のプロジェクトのパッケージ・マネージャーを使用して依存関係を追加します：

npm run tauri add global-shortcut

yarn run tauri add global-shortcut

pnpm tauri add global-shortcut

deno task tauri add global-shortcut

bun tauri add global-shortcut

cargo tauri add global-shortcut

src-tauri フォルダで次のコマンドを実行して、このプラグインを Cargo.toml 内のプロジェクトの依存関係に追加します：
```
cargo add tauri-plugin-global-shortcut --target 'cfg(any(target_os = "macos", windows, target_os = "linux"))'
```

追加したプラグインを初期化するために lib.rs を修正します：

pub fn run() {
    tauri::Builder::default()
        .setup(|app| {
            #[cfg(desktop)]
            app.handle().plugin(tauri_plugin_global_shortcut::Builder::new().build());
            Ok(())
        })
        .run(tauri::generate_context!())
        .expect("error while running tauri application");
}

お好みの JavaScript パッケージ・マネージャーを使用して、「JavaScript Guest」バインディングをインストールします：

npm install @tauri-apps/plugin-global-shortcut

yarn add @tauri-apps/plugin-global-shortcut

pnpm add @tauri-apps/plugin-global-shortcut

deno add npm:@tauri-apps/plugin-global-shortcut

bun add @tauri-apps/plugin-global-shortcut

使用法

「グローバル・ショートカット global-shortcut」プラグインは JavaScript と Rust の両方で利用可能です。

JavaScript
Rust

import { register } from '@tauri-apps/plugin-global-shortcut';
// `"withGlobalTauri": true` を使用する場合は、
// const { register } = window.__TAURI__.globalShortcut;　を使用できます

await register('CommandOrControl+Shift+C', () => {
  console.log('Shortcut triggered');
});

pub fn run() {
    tauri::Builder::default()
        .setup(|app| {
            #[cfg(desktop)]
            {
                use tauri_plugin_global_shortcut::{Code, GlobalShortcutExt, Modifiers, Shortcut, ShortcutState};

                let ctrl_n_shortcut = Shortcut::new(Some(Modifiers::CONTROL), Code::KeyN);
                app.handle().plugin(
                    tauri_plugin_global_shortcut::Builder::new().with_handler(move |_app, shortcut, event| {
                        println!("{:?}", shortcut);
                        if shortcut == &ctrl_n_shortcut {
                            match event.state() {
                              ShortcutState::Pressed => {
                                println!("Ctrl-N Pressed!");
                              }
                              ShortcutState::Released => {
                                println!("Ctrl-N Released!");
                              }
                            }
                        }
                    })
                    .build(),
                )?;

                app.global_shortcut().register(ctrl_n_shortcut)?;
            }
            Ok(())
        })
        .run(tauri::generate_context!())
        .expect("error while running tauri application");
}

アクセス権限 Permissions

デフォルトでは、潜在的に危険なプラグイン・コマンドとそのスコープ（有効範囲）はすべてブロックされており、アクセスできません。これらを有効にするには、capabilities 設定でアクセス権限を変更する必要があります。

詳細については「セキュリティ・レベル Capabilities」の章を参照してください。また、プラグインのアクセス権限を設定するには「プライグン・アクセス権の使用」の章のステップ・バイ・ステップ・ガイドを参照してください。

{
  "$schema": "../gen/schemas/desktop-schema.json",
  "identifier": "main-capability",
  "description": "Capability for the main window",
  "windows": ["main"],
  "permissions": [
    "global-shortcut:allow-is-registered",
    "global-shortcut:allow-register",
    "global-shortcut:allow-unregister"
  ]
}

Default Permission

No features are enabled by default, as we believe the shortcuts can be inherently dangerous and it is application specific if specific shortcuts should be registered or unregistered.

Permission Table

Identifier	Description
`global-shortcut:allow-is-registered`	Enables the is_registered command without any pre-configured scope.
`global-shortcut:deny-is-registered`	Denies the is_registered command without any pre-configured scope.
`global-shortcut:allow-register`	Enables the register command without any pre-configured scope.
`global-shortcut:deny-register`	Denies the register command without any pre-configured scope.
`global-shortcut:allow-register-all`	Enables the register_all command without any pre-configured scope.
`global-shortcut:deny-register-all`	Denies the register_all command without any pre-configured scope.
`global-shortcut:allow-unregister`	Enables the unregister command without any pre-configured scope.
`global-shortcut:deny-unregister`	Denies the unregister command without any pre-configured scope.
`global-shortcut:allow-unregister-all`	Enables the unregister_all command without any pre-configured scope.
`global-shortcut:deny-unregister-all`	Denies the unregister_all command without any pre-configured scope.

【※ この日本語版は、「Feb 22, 2025 英語版」に基づいています】

Support on Open Collective Sponsor on GitHub