Struct Toast 

pub struct Toast {
    pub id: ToastId,
    pub content: ToastContent,
    pub config: ToastConfig,
    pub state: ToastState,
    pub actions: Vec<ToastAction>,
    /* private fields */
}

A toast notification widget.

Toasts display transient messages to the user, typically in a corner of the screen. They can auto-dismiss after a duration or be manually dismissed.

Example

let toast = Toast::new("Operation completed")
    .icon(ToastIcon::Success)
    .position(ToastPosition::TopRight)
    .duration(Duration::from_secs(3));

// Render the toast
toast.render(area, frame);

Fields

id: ToastId

Unique identifier.

content: ToastContent

Toast content.

config: ToastConfig

Configuration.

state: ToastState

Internal state.

actions: Vec<ToastAction>

Interactive action buttons (e.g., “Undo”, “Retry”).

Implementations

impl Toast

pub fn new(message: impl Into<String>) -> Self

Create a new toast with the given message.

pub fn with_id(id: ToastId, message: impl Into<String>) -> Self

Create a toast with a specific ID.

pub fn icon(self, icon: ToastIcon) -> Self

Set the toast icon.

pub fn title(self, title: impl Into<String>) -> Self

Set the toast title.

pub fn position(self, position: ToastPosition) -> Self

Set the toast position.

pub fn duration(self, duration: Duration) -> Self

Set the auto-dismiss duration.

pub fn persistent(self) -> Self

Make the toast persistent (no auto-dismiss).

pub fn style_variant(self, variant: ToastStyle) -> Self

Set the style variant.

pub fn max_width(self, width: u16) -> Self

Set the maximum width.

pub fn margin(self, margin: u16) -> Self

Set the margin from screen edges.

pub fn dismissable(self, dismissable: bool) -> Self

Set whether the toast is dismissable.

pub fn style(self, style: Style) -> Self

Set the base style.

pub fn with_icon_style(self, style: Style) -> Self

Set the icon style.

pub fn with_title_style(self, style: Style) -> Self

Set the title style.

pub fn entrance_animation(self, animation: ToastEntranceAnimation) -> Self

Set the entrance animation.

pub fn exit_animation(self, animation: ToastExitAnimation) -> Self

Set the exit animation.

pub fn entrance_duration(self, duration: Duration) -> Self

Set the entrance animation duration.

pub fn exit_duration(self, duration: Duration) -> Self

Set the exit animation duration.

pub fn entrance_easing(self, easing: ToastEasing) -> Self

Set the entrance easing function.

pub fn exit_easing(self, easing: ToastEasing) -> Self

Set the exit easing function.

pub fn action(self, action: ToastAction) -> Self

Add a single action button to the toast.

pub fn actions(self, actions: Vec<ToastAction>) -> Self

Set all action buttons at once.

pub fn with_action_style(self, style: Style) -> Self

Set the style for action buttons.

pub fn with_action_focus_style(self, style: Style) -> Self

Set the style for the focused action button.

pub fn no_animation(self) -> Self

Disable all animations.

pub fn reduced_motion(self, enabled: bool) -> Self

Enable reduced motion mode (skips animations).

pub fn is_expired(&self) -> bool

Check if the toast has expired based on its duration.

Accounts for time spent paused (when actions are focused).

pub fn is_visible(&self) -> bool

Check if the toast should be visible.

A toast is visible if it’s not dismissed, not expired, and not in the Hidden animation phase.

pub fn is_animating(&self) -> bool

Check if the toast is currently animating.

pub fn dismiss(&mut self)

Dismiss the toast, starting exit animation.

pub fn dismiss_immediately(&mut self)

Dismiss immediately without animation.

pub fn tick_animation(&mut self) -> bool

Update the animation state. Call this each frame.

Returns true if the animation phase changed.

pub fn animation_phase(&self) -> ToastAnimationPhase

Get the current animation phase.

pub fn animation_offset(&self) -> (i16, i16)

Get the current animation offset for rendering.

Returns (dx, dy) offset to apply to the position.

pub fn animation_opacity(&self) -> f64

Get the current opacity for rendering (0.0 to 1.0).

pub fn remaining_time(&self) -> Option<Duration>

Get the remaining time before auto-dismiss.

Accounts for paused time.

pub fn handle_key(&mut self, key: KeyEvent) -> ToastEvent

Handle a key event for toast interaction.

Supported keys:

• Esc: Dismiss the toast (if dismissable).
• Tab: Cycle focus through action buttons (round-robin).
• Enter: Invoke the focused action. Returns ToastEvent::Action(id).

pub fn pause_timer(&mut self)

Pause the auto-dismiss timer.

pub fn resume_timer(&mut self)

Resume the auto-dismiss timer.

pub fn clear_focus(&mut self)

Clear action focus and resume the timer.

pub fn has_focus(&self) -> bool

Check whether any action is currently focused.

pub fn focused_action(&self) -> Option<&ToastAction>

Get the currently focused action, if any.

pub fn calculate_dimensions(&self) -> (u16, u16)

Calculate the toast dimensions based on content.

Trait Implementations

impl Clone for Toast

fn clone(&self) -> Toast

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Toast

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Widget for Toast

fn render(&self, area: Rect, frame: &mut Frame<'_>)

Render the widget into the frame at the given area.

fn is_essential(&self) -> bool

Whether this widget is essential and should always render.