Struct ZStack 

pub struct ZStack { /* private fields */ }

A view that overlays its children, aligning them in both axes.

By default, ZStack centers its children (matching SwiftUI).

Example

ZStack::new()
    .alignment(Alignment::bottom_trailing())
    .child(Image::new("background"))
    .child(Text::new("Badge"))

Implementations

impl ZStack

pub fn new() -> Self

Create a new overlay stack.

Examples found in repository

examples/storybook/stories/layout.rs (line 88)

pub fn render_zstack_story() -> impl IntoElement {
    VStack::new()
        .spacing(16.0)
        .alignment(HorizontalAlignment::Leading)
        .child(Text::new("ZStack overlays children, centered by default:"))
        .child(
            ZStack::new()
                .child(div().size(px(150.0)).bg(rgb(0x007AFF)).rounded(px(8.0)))
                .child(div().size(px(80.0)).bg(rgb(0xFF3B30)).rounded_full())
                .frame_size(200.0, 200.0)
                .background(Color::tertiary_system_background())
                .corner_radius(8.0),
        )
}

pub fn alignment(self, alignment: Alignment) -> Self

Set the alignment of children within the stack.

pub fn child<E: IntoElement>(self, child: E) -> Self

Add a child view.

Examples found in repository

examples/storybook/stories/layout.rs (line 89)

pub fn render_zstack_story() -> impl IntoElement {
    VStack::new()
        .spacing(16.0)
        .alignment(HorizontalAlignment::Leading)
        .child(Text::new("ZStack overlays children, centered by default:"))
        .child(
            ZStack::new()
                .child(div().size(px(150.0)).bg(rgb(0x007AFF)).rounded(px(8.0)))
                .child(div().size(px(80.0)).bg(rgb(0xFF3B30)).rounded_full())
                .frame_size(200.0, 200.0)
                .background(Color::tertiary_system_background())
                .corner_radius(8.0),
        )
}

pub fn children<I, E>(self, children: I) -> Self

where I: IntoIterator<Item = E>, E: IntoElement,

Add multiple children.

Trait Implementations

impl Default for ZStack

fn default() -> Self

Returns the “default value” for a type.

impl IntoElement for ZStack

type Element = Component<ZStack>

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 Modifier for ZStack

fn padding(self, value: impl Into<Padding>) -> Modified<Self>

Add padding around the view.

fn padding_edges( self, top: f32, leading: f32, bottom: f32, trailing: f32, ) -> Modified<Self>

Add padding to specific edges.

fn frame(self, frame: Frame) -> Modified<Self>

Apply a frame with the specified configuration.

fn frame_size(self, width: f32, height: f32) -> Modified<Self>

Set fixed width and height. Shorthand for frame(Frame::size(w, h)).

fn frame_width(self, width: f32) -> Modified<Self>

Set fixed width only. Shorthand for frame(Frame::width(w)).

fn frame_height(self, height: f32) -> Modified<Self>

Set fixed height only. Shorthand for frame(Frame::height(h)).

fn fixed_size(self, horizontal: bool, vertical: bool) -> Modified<Self>

Prevent the view from expanding beyond its ideal size.

fn aspect_ratio(self, ratio: f32, content_mode: ContentMode) -> Modified<Self>

Constrain the view to a specific aspect ratio.

fn background(self, color: impl Into<Color>) -> Modified<Self>

Set the background color.

fn foreground_color(self, color: impl Into<Color>) -> Modified<Self>

Set the foreground (text) color.

fn tint(self, color: impl Into<Color>) -> Modified<Self>

Set the tint color for interactive elements.

fn corner_radius(self, radius: f32) -> Modified<Self>

Round the corners.

fn border(self, color: impl Into<Color>, width: f32) -> Modified<Self>

Add a border.

fn shadow(self, radius: f32) -> Modified<Self>

Add a shadow.

fn shadow_with( self, radius: f32, color: impl Into<Color>, x: f32, y: f32, ) -> Modified<Self>

Add a shadow with full configuration.

fn opacity(self, value: f32) -> Modified<Self>

Set the opacity.

fn hidden(self, is_hidden: bool) -> Modified<Self>

Hide the view.

fn disabled(self, is_disabled: bool) -> Modified<Self>

Disable interaction.

fn scale(self, value: f32) -> Modified<Self>

Apply a scale transform.

fn on_tap_gesture( self, id: impl Into<SharedString>, handler: impl Fn() + 'static, ) -> Tappable<Self>

Add a tap gesture handler.

fn on_tap_gesture_with( self, id: impl Into<SharedString>, handler: impl Fn(&ClickEvent, &mut Window, &mut App) + 'static, ) -> Tappable<Self>

Add a tap gesture handler with access to the event.

impl RenderOnce for ZStack

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.