Struct OverlayHandle 

pub struct OverlayHandle { /* private fields */ }

Handle used by components to interact with the overlay manager through a Dioxus signal. This is designed to be provided once near the root of the app (for example inside the future App component) and then consumed via use_overlay in child components.

Implementations

impl OverlayHandle

pub fn open( &self, kind: OverlayKind, has_mask: bool, ) -> (OverlayKey, OverlayMeta)

Register a new overlay and receive its key and metadata.

pub fn update( &self, key: OverlayKey, has_mask: Option<bool>, ) -> Option<OverlayMeta>

Update metadata for an existing overlay.

pub fn close(&self, key: OverlayKey)

Close a specific overlay.

pub fn close_all(&self)

Close all overlays.

pub fn snapshot(&self) -> OverlayManager

Snapshot the current manager state. This is intended for read-only operations such as rendering overlay layers.

Trait Implementations

impl Clone for OverlayHandle

fn clone(&self) -> OverlayHandle

Returns a duplicate of the value.

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

Performs copy-assignment from source.