Skip to main content

ZStack

Struct ZStack 

Source
pub struct ZStack<C> { /* private fields */ }
Expand description

A view that overlays its children, aligning them in front of each other.

Use a ZStack when you want to layer views on top of each other. The stack sizes itself to fit its largest child.

zstack((
    Color::blue(),
    text("Overlay Text"),
))

You can control how children align within the stack:

ZStack::new(Alignment::TopLeading, (
    background_view,
    content_view,
))

Note: If you only need a decorative background without affecting layout size, use .background() instead.

Implementations§

Source§

impl<C> ZStack<C>

Source

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

Sets the alignment for the ZStack.

Source§

impl<C, F, V> ZStack<ForEach<C, F, V>>
where C: Collection, C::Item: Identifiable, F: 'static + Fn(C::Item) -> V, V: View,

Source

pub fn for_each(collection: C, generator: F) -> Self

Creates the stack by iterating over a collection and generating views.

Source§

impl<C: TupleViews> ZStack<(C,)>

Source

pub const fn new(alignment: Alignment, contents: C) -> Self

Creates a new ZStack with the specified alignment and contents.

§Arguments
  • alignment - The alignment to use for positioning children within the stack
  • contents - A collection of views to be stacked

Trait Implementations§

Source§

impl<C: Clone> Clone for ZStack<C>

Source§

fn clone(&self) -> ZStack<C>

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<C: Debug> Debug for ZStack<C>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<V> FromIterator<V> for ZStack<(Vec<AnyView>,)>
where V: View,

Source§

fn from_iter<T: IntoIterator<Item = V>>(iter: T) -> Self

Creates a value from an iterator. Read more
Source§

impl<C> View for ZStack<(C,)>
where C: TupleViews + 'static,

Source§

fn body(self, _env: &Environment) -> impl View

Build this view and return the content. Read more
Source§

impl<C, F, V> View for ZStack<ForEach<C, F, V>>
where C: Collection + Clone, C::Item: Identifiable, F: 'static + Fn(C::Item) -> V, V: View,

Source§

fn body(self, _env: &Environment) -> impl View

Build this view and return the content. Read more

Auto Trait Implementations§

§

impl<C> Freeze for ZStack<C>
where C: Freeze,

§

impl<C> RefUnwindSafe for ZStack<C>
where C: RefUnwindSafe,

§

impl<C> Send for ZStack<C>
where C: Send,

§

impl<C> Sync for ZStack<C>
where C: Sync,

§

impl<C> Unpin for ZStack<C>
where C: Unpin,

§

impl<C> UnsafeUnpin for ZStack<C>
where C: UnsafeUnpin,

§

impl<C> UnwindSafe for ZStack<C>
where C: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> IdentifiableExt for T

Source§

fn use_id<F, Id>(self, f: F) -> UseId<Self, F>
where F: Fn(&Self) -> Id, Id: Ord + Hash,

Wraps the value in a UseId with the provided identification function.
Source§

fn self_id(self) -> SelfId<Self>

Wraps the value in a SelfId, making the value serve as its own identifier.
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<V> IntoView for V
where V: View,

Source§

type Output = V

The resulting View type after conversion.
Source§

fn into_view(self, _env: &Environment) -> <V as IntoView>::Output

Converts the implementing type into a View. Read more
Source§

impl<V> PositionExt for V
where V: View,

Source§

fn position( self, x: impl IntoSignalF32, y: impl IntoSignalF32, ) -> PositionedChild<Self>

Position view’s center at absolute (x, y) coordinates. Read more
Source§

fn position_anchor( self, anchor: UnitPoint, x: impl IntoSignalF32, y: impl IntoSignalF32, ) -> PositionedChild<Self>

Position view’s anchor point at absolute coordinates. Read more
Source§

fn position_in(self, position: UnitPoint) -> PositionedChild<Self>

Position view’s center at fractional location in parent. Read more
Source§

fn position_in_anchor( self, anchor: UnitPoint, position: UnitPoint, ) -> PositionedChild<Self>

Position view’s anchor at fractional location in parent. Read more
Source§

fn position_in_offset( self, anchor: UnitPoint, position: UnitPoint, offset_x: impl IntoSignalF32, offset_y: impl IntoSignalF32, ) -> PositionedChild<Self>

Position with fractional location plus offset. Read more
Source§

fn pin(self, constraints: PinConstraints) -> PositionedChild<Self>

Position using edge pins and optional explicit size. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.