グローバルショートカット

GitHub npm crates.io

API Reference

アプリケーションがフォーカスされていないときでもグローバルキーボードショートカットを登録します。

サポートされているプラットフォーム

This plugin requires a Rust version of at least 1.77.2

Platform	Level	Notes
windows
linux
macos
android
ios

セットアップ

グローバルショートカットプラグインをインストールして開始します。

自動

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

npm

npm run tauri add global-shortcut

yarn

yarn run tauri add global-shortcut

pnpm

pnpm tauri add global-shortcut

deno

deno task tauri add global-shortcut

bun

bun tauri add global-shortcut

cargo

cargo tauri add global-shortcut

手動

1. src-tauri フォルダで次のコマンドを実行して、Cargo.toml のプロジェクトの依存関係にプラグインを追加します。

   cargo add tauri-plugin-global-shortcut --target 'cfg(any(target_os = "macos", windows, target_os = "linux"))'

2. lib.rs を変更してプラグインを初期化します。

   src-tauri/src/lib.rs

   #[cfg_attr(mobile, tauri::mobile_entry_point)]
   pub fn run() {
       tauri::Builder::default()
           .plugin(tauri_plugin_global_shortcut::Builder::new().build())
           .run(tauri::generate_context!())
           .expect("error while running tauri application");
   }

3. お好みの JavaScript パッケージマネージャーを使用して、JavaScript ゲストバインディングをインストールします。

   npm

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

   yarn

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

   pnpm

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

   deno

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

   bun

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

使用法

グローバルショートカットプラグインは、JavaScript と Rust の両方で使用できます。

JavaScript

import { register } from '@tauri-apps/plugin-global-shortcut';

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

Rust

use tauri_plugin_global_shortcut::{Code, GlobalShortcutExt, Modifiers, Shortcut, ShortcutState};

fn register_shortcut(app: &mut tauri::App) {
    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)?;
}

権限

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

詳細については、機能の概要 と、プラグイン権限を使用するための ステップバイステップガイド を参照してください。

src-tauri/capabilities/default.json

{
  "permissions": [
    ...,
    "global-shortcut:allow-register",
  ]
}

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.