https://github.com/allenbenz/winrt-notification
An incomplete wrapper over the WinRT toast api written in rust
https://github.com/allenbenz/winrt-notification
notification rust
Last synced: 3 months ago
JSON representation
An incomplete wrapper over the WinRT toast api written in rust
- Host: GitHub
- URL: https://github.com/allenbenz/winrt-notification
- Owner: allenbenz
- Created: 2017-09-24T03:27:27.000Z (almost 9 years ago)
- Default Branch: main
- Last Pushed: 2024-04-18T02:21:52.000Z (about 2 years ago)
- Last Synced: 2025-11-27T12:38:31.173Z (7 months ago)
- Topics: notification, rust
- Language: Rust
- Homepage:
- Size: 4.98 MB
- Stars: 45
- Watchers: 2
- Forks: 36
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# winrt-notification
[](https://crates.io/crates/winrt-notification/)
[](https://crates.io/crates/winrt-notification/)
[](https://ci.appveyor.com/project/allenbenz/winrt-notification)
An incomplete wrapper over the WinRT toast api
Tested in Windows 10 and 8.1. Untested in Windows 8, might work.
[0.5 Documentation](https://allenbenz.github.io/winrt-notification/0_5_0/winrt_notification/index.html)
[0.2 Documentation](https://allenbenz.github.io/winrt-notification/0_2_0/winrt_notification/index.html)
Todo:
* Add support for Adaptive Content
* Add support for Actions
Known Issues:
* Will not work for Windows 7.
Limitations:
* Windows 8.1 only supports a single image, the last image (icon, hero, image) will be the one on the toast
## Usage
```toml
#Cargo.toml
[dependencies]
winrt-notification = "0.5.1"
```
## Examples
```rust
extern crate winrt_notification;
use winrt_notification::{Duration, Sound, Toast};
fn main() {
Toast::new(Toast::POWERSHELL_APP_ID)
.title("Look at this flip!")
.text1("(╯°□°）╯︵ ┻━┻")
.sound(Some(Sound::SMS))
.duration(Duration::Short)
.show()
.expect("unable to toast");
}
```
```rust
extern crate winrt_notification;
use std::path::Path;
use winrt_notification::{IconCrop, Toast};
fn main() {
Toast::new("Your AppUserModeId")
.hero(&Path::new("C:\\absolute\\path\\to\\image.jpeg"), "alt text")
.icon(
&Path::new("c:/this/style/works/too/image.png"),
IconCrop::Circular,
"alt text",
)
.title("Lots of pictures here")
.text1("One above the text as the hero")
.text2("One to the left as an icon, and several below")
.image(&Path::new("c:/photos/sun.png"), "the sun")
.image(&Path::new("c:/photos/moon.png"), "the moon")
.sound(None) // will be silent
.show()
.expect("unable to toast");
}
```