11 Global Shortcut

原文链接: https://tauri.app/plugin/global-shortcut/

注册全局快捷键。

支持的平台

平台支持程度说明
Windows完整支持
Linux完整支持
macOS完整支持
Android不支持
iOS不支持

设置

自动

使用你的项目包管理器添加依赖:

1
npm run tauri add global-shortcut
1
yarn run tauri add global-shortcut
1
pnpm tauri add global-shortcut
1
deno task tauri add global-shortcut
1
bun tauri add global-shortcut
1
cargo tauri add global-shortcut

手动

  1. 在 src-tauri 文件夹中运行以下命令,把插件加入 Cargo.toml 里的项目依赖:

    1
    
    cargo add tauri-plugin-global-shortcut
    
  2. 修改 lib.rs 初始化插件:

    1
    2
    3
    4
    5
    6
    7
    
    #[cfg_attr(mobile, tauri::mobile_entry_point)]
    pub fn run() {
        tauri::Builder::default()
            .plugin(tauri_plugin_global_shortcut::init())
            .run(tauri::generate_context!())
            .expect("error while running tauri application");
    }
    
  3. 用你偏好的 JavaScript 包管理器安装 JavaScript 端绑定:

1
npm install @tauri-apps/plugin-global-shortcut
1
yarn add @tauri-apps/plugin-global-shortcut
1
pnpm add @tauri-apps/plugin-global-shortcut
1
deno add npm:@tauri-apps/plugin-global-shortcut
1
bun add @tauri-apps/plugin-global-shortcut

用法

global-shortcut 插件在 JavaScript 和 Rust 中都可以使用。

语言

1
2
3
4
5
6
7
import { register } from '@tauri-apps/plugin-global-shortcut';
// 使用 `"withGlobalTauri": true` 时,你可以这样写
// const { register } = window.__TAURI__.globalShortcut;

await register('CommandOrControl+Shift+C', () => {
  console.log('Shortcut triggered');
});
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
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");
}

权限

默认情况下,所有有潜在危险的插件命令和作用域都被阻止,无法访问。你必须在 capabilities 配置中修改权限才能启用它们。

更多信息请参阅能力概述,以及使用插件权限的分步指南。

1
2
3
4
5
6
{
  "permissions": [
    ...,
    "global-shortcut:default"
  ]
}
最后修改 September 26, 2026: 更新 (630b11f59)