tray-icon 0.25.1

Create tray icons for desktop applications
Documentation

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

Platforms supported:

  • Windows
  • macOS
  • Linux (AppIndicator or KSNI)
  • FreeBSD (AppIndicator or KSNI)

Platform-specific notes:

  • On Windows and the Linux/FreeBSD AppIndicator backend, an event loop must be running on the thread. The KSNI backend manages its own worker thread.
  • 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.

Cargo Features

  • libappindicator: Uses the GTK 3 AppIndicator backend on Linux and BSD. This is enabled by default and also enables muda-gtk3.
  • ksni: Uses the StatusNotifierItem D-Bus backend on Linux and BSD.
  • serde: Enables de/serializing derives.
  • muda-common-controls-v6: Forwards muda's common-controls-v6 feature.
  • muda-gtk3: Forwards muda's gtk3 feature.
  • muda-gtk4: Forwards muda's gtk4 feature.
  • muda-libxdo: Forwards muda's libxdo feature. This is enabled by default.
  • muda-serde: Forwards muda's serde feature. The serde feature also enables it.
  • muda-snapshot: Forwards muda's snapshot feature. The ksni feature also enables it.

When both libappindicator and ksni are enabled on Linux or BSD, tray-icon uses the ksni backend and emits a Cargo warning.

Dependencies (Linux/BSD)

The default Linux backend uses GTK 3, libxdo, and libappindicator or libayatana-appindicator. The ksni backend does not require these system libraries unless a muda GTK backend is also enabled.

Arch Linux / Manjaro:

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

Debian / Ubuntu:

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

Dependencies in FreeBSD

Install this dependencies in order to compile tray-icon. Instructions using pkg:

pkg install -y rust glib pkgconf gtk3

Examples

Create a tray icon without a menu.

use tray_icon::TrayIconBuilder;

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

Create a tray icon with a menu.

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();

Processing tray events

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

use tray_icon::TrayIconEvent;

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

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

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

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

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

Note for winit or tao users:

You should use [TrayIconEvent::set_event_handler] and forward the tray icon events to the event loop by using EventLoopProxy so that the event loop is awakened on each tray icon event. Same can be done for menu events using [MenuEvent::set_event_handler].

enum UserEvent {
  TrayIconEvent(tray_icon::TrayIconEvent)
  MenuEvent(tray_icon::menu::MenuEvent)
}

let event_loop = EventLoop::<UserEvent>::with_user_event().build().unwrap();

let proxy = event_loop.create_proxy();
tray_icon::TrayIconEvent::set_event_handler(Some(move |event| {
    proxy.send_event(UserEvent::TrayIconEvent(event));
}));

let proxy = event_loop.create_proxy();
tray_icon::menu::MenuEvent::set_event_handler(Some(move |event| {
    proxy.send_event(UserEvent::MenuEvent(event));
}));

License

Apache-2.0/MIT