iq-scm / tray-icon Goto Github PK

tray-icon lets you create tray icons for desktop applications.

• Windows
• macOS
• Linux (gtk Only)

• On Windows and Linux, an event loop must be running on the thread, on Windows, a win32 event loop and on Linux, a gtk event loop. It doesn't need to be the main thread but you have to create the tray icon 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 tray icon on the main thread.

On Linux, gtk and libappindicator or libayatnat-appindicator are used to create the tray icon, so make sure to install them on your system.

pacman -S gtk3 libappindicator-gtk3 #or libayatana-appindicator

sudo apt install libgtk-3-dev libappindicator3-dev #or libayatana-appindicator3-dev

if you use tray_icon::muda module, make sure to checkout https://github.com/tauri-apps/muda#dependencies

use tray_icon::TrayIconBuilder;

let tray_icon = TrayIconBuilder::new()
    .with_tooltip("system-tray - tray icon library!")
    .with_icon(icon)
    .build()
    .unwrap();

use tray_icon::{TrayIconBuilder, menu::Menu};

let tray_menu = Menu::new();
let tray_icon = TrayIconBuilder::new()
    .with_menu(Box::new(tray_menu))
    .with_tooltip("system-tray - tray icon library!")
    .with_icon(icon)
    .build()
    .unwrap();

You can use TrayEvent::receiver to get a reference to the TrayEventReceiver which you can use to listen to events when a click happens on the tray icon

use tray_icon::TrayEvent;

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

You can also listen for the menu events using TrayEvent::receiver to get events for the tray context menu.

use tray_icon::{TrayEvent, menu::{MenuEvent}};

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

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

Apache-2.0/MIT