Struct ratatui_widgets::stack_container::StackContainer

pub struct StackContainer { /* private fields */ }

A container that stacks widgets in a given direction

Examples

use ratatui::prelude::*;
use ratatui::widgets::*;
use ratatui_widgets::StackContainer;

let mut stack = StackContainer::horizontal();
stack.push(Box::new(Paragraph::new("Left")), Constraint::Fill(1));
stack.push(Box::new(Paragraph::new("Center")), Constraint::Fill(2));
stack.push(Box::new(Paragraph::new("Right")), Constraint::Fill(1));

// or

let stack = StackContainer::horizontal().with_widgets(vec![
    (Box::new(Paragraph::new("Left")), Constraint::Fill(1)),
    (Box::new(Paragraph::new("Center")), Constraint::Fill(2)),
    (Box::new(Paragraph::new("Right")), Constraint::Fill(1)),
]);

Implementations

impl StackContainer

pub fn new(direction: Direction) -> Self

pub fn horizontal() -> Self

pub fn vertical() -> Self

pub fn with_margin(self, margin: u16) -> Self

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

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

pub fn with_widget( self, widget: Box<dyn WidgetRef>, constraint: Constraint ) -> Self

pub fn with_widgets( self, widgets: Vec<(Box<dyn WidgetRef>, Constraint)> ) -> Self

pub fn push(&mut self, widget: Box<dyn WidgetRef>, constraint: Constraint)

pub fn remove(&mut self, index: usize)

Trait Implementations

impl Debug for StackContainer

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

Formats the value using the given formatter.

impl Default for StackContainer

fn default() -> StackContainer

Returns the “default value” for a type.

impl Widget for &StackContainer

fn render(self, area: Rect, buf: &mut Buffer)

Draws the current state of the widget in the given buffer. That is the only method required to implement a custom widget.