#tauri-plugin #tauri-app #global #applications #shortcut #hotkeys #listener

sys tauri-plugin-global-shortcut

Register global hotkeys listeners on your Tauri application

14 releases

2.0.0-beta.6 May 30, 2024
2.0.0-beta.3 Mar 21, 2024
2.0.0-alpha.6 Dec 20, 2023
2.0.0-alpha.4 Oct 29, 2023
2.0.0-alpha.0 May 24, 2023

#940 in GUI

Download history 282/week @ 2024-03-03 118/week @ 2024-03-10 195/week @ 2024-03-17 131/week @ 2024-03-24 144/week @ 2024-03-31 499/week @ 2024-04-07 291/week @ 2024-04-14 173/week @ 2024-04-21 340/week @ 2024-04-28 250/week @ 2024-05-05 332/week @ 2024-05-12 158/week @ 2024-05-19 935/week @ 2024-05-26 650/week @ 2024-06-02 178/week @ 2024-06-09 342/week @ 2024-06-16

2,116 downloads per month
Used in qwit-desktop

Apache-2.0 OR MIT

82KB
438 lines

plugin-global-shortcut

Register global shortcuts.

  • Supported platforms: Windows, Linux and macOS.

Install

This plugin requires a Rust version of at least 1.75

There are three general methods of installation that we can recommend.

  1. Use crates.io and npm (easiest, and requires you to trust that our publishing pipeline worked)
  2. Pull sources directly from Github using git tags / revision hashes (most secure)
  3. Git submodule install this repo in your tauri project and then use file protocol to ingest the source (most secure, but inconvenient to use)

Install the Core plugin by adding the following to your Cargo.toml file:

src-tauri/Cargo.toml

# you can add the dependencies on the `[dependencies]` section if you do not target mobile
[target."cfg(not(any(target_os = \"android\", target_os = \"ios\")))".dependencies]
tauri-plugin-global-shortcut = "2.0.0-beta"
# alternatively with Git:
tauri-plugin-global-shortcut = { git = "https://github.com/tauri-apps/plugins-workspace", branch = "v2" }

You can install the JavaScript Guest bindings using your preferred JavaScript package manager:

Note: Since most JavaScript package managers are unable to install packages from git monorepos we provide read-only mirrors of each plugin. This makes installation option 2 more ergonomic to use.

pnpm add @tauri-apps/plugin-global-shortcut
# or
npm add @tauri-apps/plugin-global-shortcut
# or
yarn add @tauri-apps/plugin-global-shortcut

# alternatively with Git:
pnpm add https://github.com/tauri-apps/tauri-plugin-global-shortcut#v2
# or
npm add https://github.com/tauri-apps/tauri-plugin-global-shortcut#v2
# or
yarn add https://github.com/tauri-apps/tauri-plugin-global-shortcut#v2

Usage

First you need to register the core plugin with Tauri:

src-tauri/src/main.rs

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

                app.handle().plugin(
                    tauri_plugin_global_shortcut::Builder::new()
                        .with_shortcuts(["ctrl+d", "alt+space"])?
                        .with_handler(|app, shortcut, event| {
                            if event.state == ShortcutState::Pressed  {
                                if shortcut.matches(Modifiers::CONTROL, Code::KeyD) {
                                    let _ = app.emit("shortcut-event", "Ctrl+D triggered");
                                }
                                if shortcut.matches(Modifiers::ALT, Code::Space) {
                                    let _ = app.emit("shortcut-event", "Alt+Space triggered");
                                }
                            }
                        })
                        .build(),
                )?;
            }

            Ok(())
        })
        .run(tauri::generate_context!())
        .expect("error while running tauri application");
}

Afterwards all the plugin's APIs are available through the JavaScript bindings:

import { register } from "@tauri-apps/plugin-global-shortcut";
await register("CommandOrControl+Shift+C", (event) => {
  if (event.state === "Pressed") {
    console.log("Shortcut triggered");
  }
});

Contributing

PRs accepted. Please make sure to read the Contributing Guide before making a pull request.

Partners

CrabNebula

For the complete list of sponsors please visit our website and Open Collective.

License

Code: (c) 2015 - Present - The Tauri Programme within The Commons Conservancy.

MIT or MIT/Apache 2.0 where applicable.

Dependencies

~16–58MB
~871K SLoC