#tray #tokio #dbusmenu #statusnotifieritem

system-tray

Async StatusNotifierItem and DBusMenu client for custom tray implementations

7 releases (breaking)

new 0.6.0 Jan 5, 2025
0.5.0 Dec 15, 2024
0.4.0 Nov 16, 2024
0.3.0 Nov 8, 2024
0.1.4 Aug 13, 2023

#196 in GUI

Download history 92/week @ 2024-09-22 92/week @ 2024-09-29 61/week @ 2024-10-06 64/week @ 2024-10-13 54/week @ 2024-10-20 62/week @ 2024-10-27 173/week @ 2024-11-03 196/week @ 2024-11-10 252/week @ 2024-11-17 126/week @ 2024-11-24 122/week @ 2024-12-01 83/week @ 2024-12-08 198/week @ 2024-12-15 147/week @ 2024-12-22 105/week @ 2024-12-29 377/week @ 2025-01-05

832 downloads per month
Used in ironbar

MIT and maybe LGPL-3.0-only

78KB
1.5K SLoC

System Tray

An async implementation of the StatusNotifierItem and DbusMenu protocols for building system trays.

Requires Tokio.

Example

use system_tray::client::Client;

#[tokio::main]
async fn main() {
    let client = Client::new().await.unwrap();
    let mut tray_rx = client.subscribe();

    let initial_items = client.items();
    
    // do something with initial items...
    
    while let Ok(ev) = tray_rx.recv().await {
        println!("{ev:?}"); // do something with event...
    }
}

dbusmenu-gtk3

Although the library provides a built-in Rust-native implementation of the DBusMenu protocol, this has a few issues:

  • There are some known bugs. For example, opening a file in VLC will break its menu.
  • If you are creating a menu UI, you need to parse the whole tree set up each element, and track all changes manually.

To circumvent this, bindings to the dbusmenu-gtk3 system library are included. When the feature of the same name is enabled, you can listen for UpdateEvent::MenuConnect and create the GTK element based on that:

fn on_update(update: system_tray::Event) {
    match update {
        Event::Update(address, UpdateEvent::MenuConnect(menu)) => {
            let menu: gtk::auto::Menu = system_tray::gtk_menu::Menu::new(&address, &menu);
            // do something with the menu element
        }
    }
}

[!NOTE] This feature is disabled by default to reduce compilation times.

Attributions

Some of the code in this repository, namely the SNI host, is taken from eww under MIT. Many thanks to elkowar.

Dependencies

~15–29MB
~480K SLoC