Global Shortcut

GitHubnpmcrates.io

Referencia de API

Registra atajos globales.

Plataformas Soportadas

Este plugin requiere una versión de Rust de al menos 1.77.2

Plataforma	Nivel	Notas
windows
linux
macos
android
ios

Configuración

Instala el plugin global-shortcut para comenzar.

Automático

Usa el gestor de paquetes de tu proyecto para agregar la dependencia:

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. Ejecuta el siguiente comando en la carpeta src-tauri para agregar el plugin a las dependencias del proyecto en Cargo.toml:

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

2. Modifica lib.rs para inicializar el 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. Instala los bindings de JavaScript utilizando tu gestor de paquetes de JavaScript preferido:

   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

Uso

El plugin global-shortcut está disponible tanto en JavaScript como en 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");
}

Permisos

De forma predeterminada, todos los comandos y alcances (scopes) potencialmente peligrosos del plugin están bloqueados y no se puede acceder a ellos. Debes modificar los permisos en tu configuración de capabilities para habilitarlos.

Consulta la Visión General de Capacidades para obtener más información y la guía paso a paso para usar permisos de plugins.

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"
  ]
}

Permiso Predeterminado

No hay características habilitadas por defecto, ya que consideramos que los atajos pueden ser inherentemente peligrosos y depende de cada aplicación si se deben registrar o desregistrar atajos específicos.

Tabla de Permisos

Identificador	Descripción
global-shortcut:allow-is-registered	Habilita el comando is_registered sin ningún ámbito preconfigurado.
global-shortcut:deny-is-registered	Deniega el comando is_registered sin ningún ámbito preconfigurado.
global-shortcut:allow-register	Habilita el comando register sin ningún ámbito preconfigurado.
global-shortcut:deny-register	Deniega el comando register sin ningún ámbito preconfigurado.
global-shortcut:allow-register-all	Habilita el comando register_all sin ningún alcance preconfigurado.
global-shortcut:deny-register-all	Deniega el comando register_all sin ningún alcance preconfigurado.
global-shortcut:allow-unregister	Habilita el comando unregister sin ningún ámbito preconfigurado.
global-shortcut:deny-unregister	Deniega el comando unregister sin ningún ámbito preconfigurado.
global-shortcut:allow-unregister-all	Habilita el comando unregister_all sin ningún alcance preconfigurado.
global-shortcut:deny-unregister-all	Deniega el comando unregister_all sin ningún alcance preconfigurado.