Struct Layout 

pub struct Layout {
    pub common: Common,
    pub direction: Option<Direction>,
    pub constraints: Vec<Constraint>,
    pub children: Vec<Node>,
    pub spacing: Option<u16>,
    pub margin: Option<Margin>,
    pub flex: Option<Flex>,
    pub collapse: Option<u16>,
}

ratatui Layout as a node: data, not geometry (§4.3). There is no split; children are attached and the renderer solves the main-axis sizes.

Fields

common: Common

Common node props (key, style, block, fallback).

direction: Option<Direction>

Main axis (default Vertical).

constraints: Vec<Constraint>

One constraint per child; missing ones are Fill(1), extras ignored.

children: Vec<Node>

Children (≤ 64, §4.8).

spacing: Option<u16>

Gap between children, in cells.

margin: Option<Margin>

Inset of the whole area.

flex: Option<Flex>

ratatui Flex (default Start).

collapse: Option<u16>

Horizontal only: below this many columns, children lay out vertically in auto mode (§4.3). 0 disables.

Implementations

impl Layout

pub fn vertical(constraints: impl IntoIterator<Item = Constraint>) -> Self

Vertical layout with one constraint per child.

pub fn horizontal(constraints: impl IntoIterator<Item = Constraint>) -> Self

Horizontal layout with one constraint per child.

pub fn constraints( self, constraints: impl IntoIterator<Item = Constraint>, ) -> Self

Sets the constraints.

pub fn children(self, children: impl IntoIterator<Item = Node>) -> Self

Attaches children (header.into() converts builder values to Node).

pub fn spacing(self, spacing: u16) -> Self

Sets the gap between children.

pub fn margin(self, margin: Margin) -> Self

Sets the inset of the whole area.

pub fn flex(self, flex: Flex) -> Self

Sets the Flex mode.

pub fn collapse(self, collapse: u16) -> Self

Sets the horizontal collapse threshold (§4.3).

Trait Implementations

impl Clone for Layout

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Layout

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

Formats the value using the given formatter.

impl Default for Layout

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Layout

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Layout> for Node

fn from(l: Layout) -> Self

Converts to this type from the input type.

impl IntoNode for Layout

fn into_node(self) -> Node

Converts into a node.

impl PartialEq for Layout

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for Layout

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Layout

impl WithCommon for Layout

fn common_mut(&mut self) -> &mut Common

Mutable access to the node’s common props.

fn key(self, key: impl Into<Key>) -> Self

Sets the node key.

fn style(self, style: Style) -> Self

Sets the base style.

fn block(self, block: impl Into<BlockProps>) -> Self

Sets the surrounding block.

fn fallback(self, node: impl Into<Node>) -> Self

Sets the fallback node.