Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/urholaukkarinen/egui-toast

Toast notifications for the egui library
https://github.com/urholaukkarinen/egui-toast

Last synced: 7 days ago
JSON representation

Toast notifications for the egui library

Awesome Lists containing this project

README

        

# egui-toast

[![Latest version](https://img.shields.io/crates/v/egui-toast.svg)](https://crates.io/crates/egui-toast)
[![Documentation](https://docs.rs/egui-toast/badge.svg)](https://docs.rs/egui-toast)
![MIT](https://img.shields.io/badge/license-MIT-blue.svg)

Toast notifications for the [egui](https://github.com/emilk/egui) library.

[Try it out in a web demo](https://urholaukkarinen.github.io/egui-toast/)

![Toast types](toasts.png)

## Quick start

```shell
cargo run -p egui-toast-demo
# or in wasm
cd demo && trunk serve
```

```rust
let mut toasts = Toasts::new()
.anchor(Align2::RIGHT_BOTTOM, (-10.0, -10.0)) // 10 units from the bottom right corner
.direction(egui::Direction::BottomUp);

if ui.button("Add toast").clicked() {
toasts.add(Toast {
text: "Hello, World!".into(),
kind: ToastKind::Error,
options: ToastOptions::default()
.duration_in_seconds(5.0)
.show_progress(true),
..Default::default()
});
}

// Show and update all toasts
toasts.show(ctx);
```

## Customization

Look of the notifications can be fully customized.

```rust
const MY_CUSTOM_TOAST: u32 = 0;

fn my_custom_toast_contents(ui: &mut Ui, toast: &mut Toast) -> Response {
egui::Frame::default()
.fill(Color32::from_rgb(33, 150, 243))
.inner_margin(Margin::same(12.0))
.rounding(4.0)
.show(ui, |ui| {
ui.label(toast.text.clone().color(Color32::WHITE));

if ui.button("Close me").clicked() {
toast.close();
}
}).response
}

let mut toasts = Toasts::new()
.custom_contents(MY_CUSTOM_TOAST, my_custom_toast_contents);

if ui.button("Add toast").clicked() {
toasts.add(Toast {
text: "Hello, World!".into(),
kind: ToastKind::Custom(MY_CUSTOM_TOAST),
options: ToastOptions::default(),
..Default::default()
});
}

toasts.show(ctx);
```