Struct VStack 

pub struct VStack;

Vertical stack container — children render top-to-bottom.

VStack renders nothing itself; it exists purely to group children. Each child receives the full parent width and its own desired_height.

This is the default layout direction and the implicit root of every renderer. Use it explicitly when you need a named group:

element! {
    VStack {
        Spinner(label: "Step 1...")
        Spinner(label: "Step 2...")
    }
}

Trait Implementations

impl ChildCollector for VStack

type Collector = Elements

The type used to accumulate children.

type Output = ComponentWithSlot<VStack>

The output type after finalizing children.

fn finish(self, collector: Elements) -> ComponentWithSlot<VStack>

Finalize children collection, producing the output value.

impl Component for VStack

type State = ()

State type for this component. The framework wraps it in Tracked<S> for automatic dirty detection.

fn render(&self, _area: Rect, _buf: &mut Buffer, _state: &())

Render into the given buffer region using current state. Can use any ratatui Widget internally.

fn desired_height(&self, _width: u16, _state: &()) -> u16

How tall does this component want to be at the given width?

fn handle_event_capture( &self, _event: &Event, _state: &mut Tracked<Self::State>, ) -> EventResult

Handle an input event during the capture phase (root → focused).

fn handle_event( &self, _event: &Event, _state: &mut Tracked<Self::State>, ) -> EventResult

Handle an input event during the bubble phase (focused → root).

fn is_focusable(&self, _state: &Self::State) -> bool

Whether this component can receive focus.

fn cursor_position( &self, _area: Rect, _state: &Self::State, ) -> Option<(u16, u16)>

Where to position the terminal’s hardware cursor when this component has focus. Returns (col, row) relative to the component’s render area, or None to hide the cursor.

fn initial_state(&self) -> Option<Self::State>

Create the initial state for this component.

fn content_inset(&self, _state: &Self::State) -> Insets

Insets for the content area within this component’s render area.

fn layout(&self) -> Layout

Layout direction for this component’s children.

fn width_constraint(&self) -> WidthConstraint

Width constraint for this component within a horizontal container.

fn lifecycle(&self, _hooks: &mut Hooks<Self::State>, _state: &Self::State)

Declare lifecycle effects for this component.

fn children( &self, _state: &Self::State, slot: Option<Elements>, ) -> Option<Elements>

Return child elements for this component.

impl Default for VStack

fn default() -> VStack

Returns the “default value” for a type.