etui - v1.0.0

etui/widgets/notification

Types

Corner

</>

Which screen corner to render notifications in.

pub type Corner {
  TopRight
  TopLeft
  BottomRight
  BottomLeft
}

Constructors 

  • TopRight
  • TopLeft
  • BottomRight
  • BottomLeft

Level

</>

Notification severity level.

pub type Level {
  Info
  Success
  Warning
  Error
}

Constructors 

  • Info
  • Success
  • Warning
  • Error

Notification

</>

A single notification.

pub type Notification {
  Notification(message: String, level: Level, ttl: Int)
}

Constructors 

  • Notification(message: String, level: Level, ttl: Int)

    Arguments

    ttl

    Remaining ticks before expiry. 0 = expired, -1 = persistent.

NotificationQueue

</>

Active notification queue.

pub type NotificationQueue {
  NotificationQueue(
    items: List(Notification),
    max: Int,
    corner: Corner,
  )
}

Constructors 

  • NotificationQueue(
  items: List(Notification),
  max: Int,
  corner: Corner,
)

    Arguments

    max

    Maximum simultaneous notifications shown (oldest dropped first).

    corner

    Corner to stack notifications in.

Values

count

</> 
pub fn count(q: NotificationQueue) -> Int

Count of active notifications.

dismiss_all

</> 
pub fn dismiss_all(q: NotificationQueue) -> NotificationQueue

Dismiss all notifications.

dismiss_first

</> 
pub fn dismiss_first(q: NotificationQueue) -> NotificationQueue

Dismiss the oldest notification.

dismiss_level

</> 
pub fn dismiss_level(
  q: NotificationQueue,
  level: Level,
) -> NotificationQueue

Dismiss all notifications matching level.

error

</> 
pub fn error(message: String, ttl ttl: Int) -> Notification

Build an Error notification (persistent by default: ttl = -1).

has_notifications

</> 
pub fn has_notifications(q: NotificationQueue) -> Bool

True if there are active notifications.

info

</> 
pub fn info(message: String, ttl ttl: Int) -> Notification

Build an Info notification.

persistent

</> 
pub fn persistent(message: String, level: Level) -> Notification

Persistent notification (never auto-expires; dismiss manually).

push

</> 
pub fn push(
  q: NotificationQueue,
  n: Notification,
) -> NotificationQueue

Add a notification. If queue is full, the oldest is dropped.

queue_new

</> 
pub fn queue_new(max max: Int) -> NotificationQueue

New empty queue. Max = 5, corner = BottomRight.

render

</> 
pub fn render(
  buf: buffer.Buffer,
  area: geometry.Rect,
  q: NotificationQueue,
) -> buffer.Buffer

Render all active notifications stacked in the configured corner. Each notification is a single-row bordered box; they stack inward.

success

</> 
pub fn success(message: String, ttl ttl: Int) -> Notification

Build a Success notification.

tick

</> 
pub fn tick(q: NotificationQueue) -> NotificationQueue

Advance time by one tick. Decrements TTL on all non-persistent notifications and removes expired ones (ttl == 0).

warning

</> 
pub fn warning(message: String, ttl ttl: Int) -> Notification

Build a Warning notification.

with_corner

</> 
pub fn with_corner(
  q: NotificationQueue,
  corner: Corner,
) -> NotificationQueue

Set which corner to stack notifications.

✨ Search Document