#tray #tokio #dbusmenu #statusnotifieritem

system-tray

Async StatusNotifierItem and DBusMenu client for custom tray implementations

5 releases (3 breaking)

0.4.0 Nov 16, 2024
0.3.0 Nov 8, 2024
0.2.0 Mar 29, 2024
0.1.5 Jan 27, 2024
0.1.4 Aug 13, 2023

#180 in GUI

Download history 33/week @ 2024-08-19 41/week @ 2024-08-26 45/week @ 2024-09-02 68/week @ 2024-09-09 88/week @ 2024-09-16 89/week @ 2024-09-23 89/week @ 2024-09-30 61/week @ 2024-10-07 64/week @ 2024-10-14 54/week @ 2024-10-21 55/week @ 2024-10-28 204/week @ 2024-11-04 218/week @ 2024-11-11 226/week @ 2024-11-18 109/week @ 2024-11-25 121/week @ 2024-12-02

707 downloads per month
Used in ironbar

MIT and maybe LGPL-3.0-only

75KB
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.

Dependencies

~15–29MB
~491K SLoC