VStack

VStack — a vertical layout container that distributes children top-to-bottom.

Public functions

VStack

Detailed description

Each child is offered the full container width and its intrinsic preferred height. Positive slack (container height minus the sum of children heights minus spacing) is distributed among children that declare a non-zero flex weight (e.g. Expand). Over-constraint deficits are absorbed by children with a non-zero shrink weight. Cross-axis (horizontal) alignment defaults to Leading and can be overridden per container with VStack::alignment or per child via WidgetTree::set_alignment.

Use VStack when children should be stacked vertically with a configurable gap; use HStack for the horizontal counterpart.

#![allow(unused)]
fn main() {
use teksilo_widgets::primitives::{VStack, TextWidget};
use teksilo_i18n::lit;
let _col = VStack::new()
    .spacing(8.0)
    .child(TextWidget::new(lit!("Heading")))
    .child(TextWidget::new(lit!("Body text")));
}

Density

The picture above is the widget at TargetDensity::Compact, the mouse-and-keyboard ladder. Below is the same subject on the same canvas with only the ladder changed, so what moves is the density and nothing else — where the subject no longer fits, that is what the denser targets cost it at that size. See docs/density-and-targets.md.

Touch

API reference

📖 Full rustdoc API for this module

pub struct VStack

Import: use teksilo::widgets::VStack;

Vertical layout container that distributes children top-to-bottom based on their intrinsic sizes. Cross-axis alignment is controlled by HAlignment (default: Leading).

#![allow(unused)]
fn main() {
pub struct VStack { /* fields */ }
}

Methods

pub fn new() -> Self

Create an empty vertical stack with Leading alignment and zero spacing.

pub fn spacing(mut self, spacing: impl Into<Prop<f32>>) -> Self (default: 0.0)

Set inter-child spacing. Accepts a static f32 or a reactive Signal<f32>.

pub fn alignment(mut self, alignment: HAlignment) -> Self (default: HAlignment::Leading)

Set the cross-axis (horizontal) alignment applied to every child that does not have a per-child override set via WidgetTree::set_alignment.

pub fn child(mut self, widget: impl teksilo_core::IntoTeksiChild) -> Self

Add an inline child widget (deferred insertion).

pub fn children( mut self, iter: impl IntoIterator<Item = impl teksilo_core::IntoTeksiChild>, ) -> Self

Add multiple inline children from an iterator.

pub fn child_opt(mut self, widget: Option<impl teksilo_core::IntoTeksiChild>) -> Self

Conditionally add a child. No-op if None.