Crate bitbar

Expand description

This is bitbar, a library crate which includes helpers for writing BitBar plugins in Rust. BitBar is a system that makes it easy to add menus to the macOS menu bar. There are two apps implementing the BitBar system: SwiftBar and xbar. This crate supports both of them, as well as the discontinued original BitBar app.

There are two main entry points:

It’s recommended to use the main attribute and write a main function that returns a Menu, along with optional command functions and an optional fallback_command function.
For additional control over your plugin’s behavior, you can directly Display a Menu.

BitBar plugins must have filenames of the format name.duration.extension, even though macOS binaries normally don’t have extensions. You will have to add an extension, e.g. .o, to make Rust binaries work as plugins.

Example

use bitbar::{Menu, MenuItem};

#[bitbar::main]
fn main() -> Menu {
    Menu(vec![
        MenuItem::new("Title"),
        MenuItem::Sep,
        MenuItem::new("Menu Item"),
    ])
}

Or:

use bitbar::{Menu, MenuItem};

fn main() {
    print!("{}", Menu(vec![
        MenuItem::new("Title"),
        MenuItem::Sep,
        MenuItem::new("Menu Item"),
    ]));
}