全局快捷方式

GitHub npm crates.io

API Reference

注册全局快捷方式。

¥Register global shortcuts.

支持的平台

¥Supported Platforms

This plugin requires a Rust version of at least 1.77.2

Platform	Level	Notes
windows
linux
macos
android
ios

设置

¥Setup

安装全局快捷方式插件即可开始使用。

¥Install the global-shortcut plugin to get started.

Automatic

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

¥Use your project’s package manager to add the dependency:

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

Manual

1. Run the following command in the src-tauri folder to add the plugin to the project’s dependencies in Cargo.toml:

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

2. Modify lib.rs to initialize the plugin:

   src-tauri/src/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");
   }

3. Install the JavaScript Guest bindings using your preferred JavaScript package manager:

   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

使用

¥Usage

global-shortcut 插件在 JavaScript 和 Rust 中均可用。

¥The global-shortcut plugin is available in both JavaScript and Rust.

JavaScript

import { register } from '@tauri-apps/plugin-global-shortcut';
// when using `"withGlobalTauri": true`, you may use
// const { register } = window.__TAURI__.globalShortcut;

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

Rust

src-tauri/src/lib.rs

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 配置中的权限才能启用这些权限。

¥By default all potentially dangerous plugin commands and scopes are blocked and cannot be accessed. You must modify the permissions in your capabilities configuration to enable these.

有关更详细的说明，请参阅 功能概述。

¥See the Capabilities Overview for more information and the step by step guide to use plugin permissions.

src-tauri/capabilities/default.json

{
  "$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.