Struct Overlay 

pub struct Overlay {
    pub id: Option<NodeId>,
    pub content: Box<Node>,
    pub overlay: Box<Node>,
}

A widget that renders an overlay layer on top of its content.

The content is drawn first, then overlay is drawn on top, filling the same bounds via a ZStack internally.

Example

Overlay {
    content: Box::new(main_content),
    overlay: Box::new(loading_spinner),
    ..Default::default()
}

Fields

id: Option<NodeId>

Explicit node identity.

content: Box<Node>

The primary content (drawn first / underneath).

overlay: Box<Node>

The overlay content (drawn second / on top).

Implementations

impl Overlay

pub fn into_node(self) -> Node

Trait Implementations

impl Clone for Overlay

fn clone(&self) -> Overlay

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Overlay

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

Formats the value using the given formatter.

impl Default for Overlay

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Overlay

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Overlay> for Node

fn from(w: Overlay) -> Self

Converts to this type from the input type.

impl Lower for Overlay

fn lower(&self, cx: &mut LoweringContext<'_>) -> NodeId

Lower this widget into the IR, returning the root node id.

impl Serialize for Overlay

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<S: AppState> Widget<S> for Overlay

fn build(&self, _ctx: &mut BuildCtx<S>, _view: &View<'_, S>) -> Node

Build the widget’s node tree.