Skip to content
☝️Send Desktop Notifications on linux and bsd
Rust
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
examples
src
tests
.gitignore
.gitmodules
.travis.yml
Cargo.toml
History.md
LICENSE-Apache
LICENSE-MIT
README.md
capabilities.md
renovate.json
rustfmt.toml
server_infos.yaml

README.md

notify-rust

Travis license Crates.io version documentation maintenance constributors

A not so well-named library for displaying desktop notifications. On linux/bsd it uses dbus-rs, so it does not rely on libnotify. On macos it uses mac-notification-sys.

[dependencies]
notify-rust = "3"

Requirements

  • rustc >= 1.32
  • linux, with libdbus (see dbus-rs)
  • macos
  • no windows support, yet

Examples

Example 1 (Simple Notification)

use notify_rust::Notification;
Notification::new()
    .summary("Firefox News")
    .body("This will almost look like a real firefox notification.")
    .icon("firefox")
    .show()?;

Example 2 (Persistent Notification)

use notify_rust::Notification;
use notify_rust::NotificationHint as Hint;
Notification::new()
    .summary("Category:email")
    .body("This has nothing to do with emails.\nIt should not go away until you acknowledge it.")
    .icon("thunderbird")
    .appname("thunderbird")
    .hint(Hint::Category("email".to_owned()))
    .hint(Hint::Resident(true)) // this is not supported by all implementations
    .timeout(0) // this however is
    .show()?;

Usage & Documentation

Please see the documentation for current examples.

Commandline tool

Checkout toastify, it exposes most of the functionality of the lib to the commandline.

macOS support

This library shines on linux and bsd, which is its original target platform. Lately it gained support for macOS thanks to mac-notification-sys. However this only includes a small subset of the current functionality, since NSNotifications don't have as many features. Please refer to the You are a versed macOS UI developer with mad Objective-C skillz? PRSV.

Contribution

Any help in form of descriptive and friendly issues or comprehensive pull requests are welcome!

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in notify-rust by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

You can’t perform that action at this time.