Struct Overlay 

pub struct Overlay { /* private fields */ }

A floating surface.

The caller owns whether the overlay exists at all; this type owns only where it paints, what sits behind it, and how a dismissal is reported.

Implementations

impl Overlay

pub fn new(ident: impl Into<Ident>) -> Self

pub fn modal(ident: impl Into<Ident>) -> Self

A dialog: centered, on the modal layer, behind a scrim.

pub fn edge(ident: impl Into<Ident>, edge: Edge) -> Self

A drawer: pinned to one side of the window, on the modal layer, behind a scrim.

pub fn layer(self, layer: Layer) -> Self

pub fn placement(self, placement: Placement) -> Self

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

Dims and blocks the content behind the overlay.

pub fn child(self, content: impl IntoElement) -> Self

pub fn on_dismiss( self, handler: impl Fn(&mut Window, &mut App) + 'static, ) -> Self

Reports a click on the scrim. Escape is the caller’s to bind, because only the caller knows which action closing should dispatch.

Trait Implementations

impl Debug for Overlay

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

Formats the value using the given formatter.

impl IntoElement for Overlay

type Element = ViewElement<Overlay>

The specific type of element into which the implementing type is converted. Useful for converting other types into elements automatically, like Strings

fn into_element(self) -> Self::Element

Convert self into a type that implements Element.

fn into_any_element(self) -> AnyElement

Convert self into a dynamically-typed AnyElement.

impl RenderOnce for Overlay

fn render(self, window: &mut Window, cx: &mut App) -> impl IntoElement

Render this component into an element tree. Note that this method takes ownership of self, as compared to Render::render() method which takes a mutable reference.