Struct OverlayStack 

pub struct OverlayStack { /* private fields */ }

A stack of overlays with focus management.

The topmost overlay receives keyboard input. Overlays are dismissed with Esc (pops the top) and never block Ctrl+C.

Implementations

impl OverlayStack

pub fn new() -> Self

Create an empty overlay stack.

pub fn is_empty(&self) -> bool

Whether there are any active overlays.

pub fn len(&self) -> usize

Number of active overlays.

pub fn has_focus(&self) -> bool

Whether the overlay stack has focus (any overlay is showing).

pub fn top_kind(&self) -> Option<OverlayKind>

Get the topmost overlay kind (if any).

pub fn push(&mut self, entry: OverlayEntry)

Push an overlay onto the stack. If an overlay of the same kind already exists, it is replaced (moved to top).

pub fn toggle(&mut self, entry: OverlayEntry)

Toggle an overlay: if the kind is already showing, dismiss it; otherwise push it.

pub fn pop(&mut self) -> Option<OverlayEntry>

Dismiss (pop) the topmost overlay. Returns the dismissed entry.

pub fn dismiss(&mut self, kind: OverlayKind)

Dismiss a specific overlay kind.

pub fn clear(&mut self)

Dismiss all overlays.

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

Render all overlays onto the frame, from bottom to top.

pub fn iter(&self) -> impl Iterator<Item = &OverlayEntry>

Get an iterator over overlay entries (bottom to top).

Trait Implementations

impl Default for OverlayStack

fn default() -> Self

Returns the “default value” for a type.