#windowing #global #hotkey

global-hotkey

Global hotkeys for Desktop Applications

13 unstable releases (4 breaking)

0.4.2 Jan 18, 2024
0.4.1 Nov 24, 2023
0.4.0 Oct 19, 2023
0.2.3 Jul 8, 2023
0.1.2 Feb 12, 2023

#309 in GUI

Download history 263/week @ 2023-10-30 483/week @ 2023-11-06 736/week @ 2023-11-13 956/week @ 2023-11-20 538/week @ 2023-11-27 733/week @ 2023-12-04 979/week @ 2023-12-11 1008/week @ 2023-12-18 415/week @ 2023-12-25 596/week @ 2024-01-01 962/week @ 2024-01-08 773/week @ 2024-01-15 534/week @ 2024-01-22 885/week @ 2024-01-29 906/week @ 2024-02-05 1134/week @ 2024-02-12

3,489 downloads per month
Used in 2 crates

Apache-2.0 OR MIT

64KB
1.5K SLoC

global_hotkey lets you register Global HotKeys for Desktop Applications.

Platforms-supported:

  • Windows
  • macOS
  • Linux (X11 Only)

Platform-specific notes:

  • On Windows a win32 event loop must be running on the thread. It doesn't need to be the main thread but you have to create the global hotkey manager on the same thread as the event loop.
  • On macOS, an event loop must be running on the main thread so you also need to create the global hotkey manager on the main thread.

Example

use global_hotkey::{GlobalHotKeyManager, hotkey::{HotKey, Modifiers, Code}};

// initialize the hotkeys manager
let manager = GlobalHotKeyManager::new().unwrap();

// construct the hotkey
let hotkey = HotKey::new(Some(Modifiers::SHIFT), Code::KeyD);

// register it
manager.register(hotkey);

Processing global hotkey events

You can also listen for the menu events using GlobalHotKeyEvent::receiver to get events for the hotkey pressed events.

use global_hotkey::GlobalHotKeyEvent;

if let Ok(event) = GlobalHotKeyEvent::receiver().try_recv() {
    println!("{:?}", event);
}

License

Apache-2.0/MIT

Dependencies

~1–12MB
~118K SLoC