Struct Toasts

pub struct Toasts { /* private fields */ }

Main notifications collector.

Usage

You need to create Toasts once and call .show(ctx) in every frame.

use egui_notify::Toasts;

let mut t = Toasts::default();
t.info("Hello, World!").duration(Some(Duration::from_secs(5))).closable(true);
// More app code
t.show(ctx);

Implementations

impl Toasts

pub const fn new() -> Self

Creates new Toasts instance.

pub fn add(&mut self, toast: Toast) -> &mut Toast

Adds new toast to the collection. By default adds toast at the end of the list, can be changed with self.reverse.

pub fn dismiss_oldest_toast(&mut self)

Dismisses the oldest toast

pub fn dismiss_latest_toast(&mut self)

Dismisses the most recent toast

pub fn dismiss_all_toasts(&mut self)

Dismisses all toasts

pub fn len(&self) -> usize

Returns the number of toast items.

pub fn is_empty(&self) -> bool

Returns true if there are no toast items.

pub fn success(&mut self, caption: impl Into<WidgetText>) -> &mut Toast

Shortcut for adding a toast with info success.

pub fn info(&mut self, caption: impl Into<WidgetText>) -> &mut Toast

Shortcut for adding a toast with info level.

pub fn warning(&mut self, caption: impl Into<WidgetText>) -> &mut Toast

Shortcut for adding a toast with warning level.

pub fn error(&mut self, caption: impl Into<WidgetText>) -> &mut Toast

Shortcut for adding a toast with error level.

pub fn basic(&mut self, caption: impl Into<WidgetText>) -> &mut Toast

Shortcut for adding a toast with no level.

pub fn custom( &mut self, caption: impl Into<WidgetText>, level_string: String, level_color: Color32, ) -> &mut Toast

Shortcut for adding a toast with custom level.

pub const fn reverse(self, reverse: bool) -> Self

Should toasts be added in reverse order?

pub const fn with_anchor(self, anchor: Anchor) -> Self

Where toasts should appear.

pub const fn with_spacing(self, spacing: f32) -> Self

Sets spacing between adjacent toasts.

pub const fn with_margin(self, margin: Vec2) -> Self

Margin or distance from screen to toasts’ bounding boxes

pub const fn with_shadow(self, shadow: Shadow) -> Self

Enables the use of a shadow for toasts.

pub const fn with_padding(self, padding: Vec2) -> Self

Padding or distance from toasts’ bounding boxes to inner contents.

pub fn with_default_font(self, font: FontId) -> Self

Changes the default font used for all toasts.

impl Toasts

pub fn show(&mut self, ctx: &Context)

Displays toast queue

Trait Implementations

impl Default for Toasts

fn default() -> Self

Returns the “default value” for a type.