ailloli_ui_widgets/layout/
column.rs

1//! Declarative vertical flex container.
2
3use super::flex::{layout_insets_only, layout_sizing_only, FlexWidget};
4use super::layout_ext::{finish_view_sized, FlexLayoutExt};
5use super::style_wrappers::apply_margin_padding;
6use ailloli_ui_core::style::{FlexStyle, LayoutSizeHint, LayoutStyle};
7use ailloli_ui_runtime::component::{IntoView, View};
8
9/// Vertical flex container with ordered retained children.
10///
11/// Defaults to automatic sizing, zero gap, start alignment, and no children.
12/// Margin/padding are realized as outer wrappers while sizing remains on the
13/// inner flex widget.
14///
15/// # Examples
16///
17/// ```
18/// use ailloli_ui_widgets::{layout::Column, text::Text};
19/// let column: Column<()> = Column::new().gap(4.0).child(Text::new("first")).child(Text::new("second"));
20/// let _ = column;
21/// ```
22pub struct Column<A = ()> {
23    /// Outer logical sizing policy.
24    pub(crate) layout: LayoutStyle,
25    /// Vertical direction, gap, and cross-axis alignment.
26    pub(crate) flex: FlexStyle,
27    /// Parent-flex participation metadata.
28    pub(crate) flex_item: ailloli_ui_core::style::FlexItemStyle,
29    /// Ordered retained children laid out from top to bottom.
30    children: Vec<View<A>>,
31}
32
33crate::impl_layout_builders!(Column);
34crate::impl_flex_builders!(Column);
35
36/// Creates the same empty column as [`Column::new`].
37impl<A: 'static> Default for Column<A> {
38    fn default() -> Self {
39        Self::new()
40    }
41}
42
43impl<A: 'static> Column<A> {
44    /// Creates an empty vertical flex container.
45    ///
46    /// # Examples
47    ///
48    /// ```
49    /// use ailloli_ui_widgets::layout::Column;
50    /// let column: Column<()> = Column::new();
51    /// let _ = column;
52    /// ```
53    pub fn new() -> Self {
54        Self {
55            layout: LayoutStyle::default(),
56            flex: FlexStyle::column(),
57            flex_item: ailloli_ui_core::style::FlexItemStyle::default(),
58            children: Vec::new(),
59        }
60    }
61
62    /// Appends one child after existing children.
63    ///
64    /// # Examples
65    ///
66    /// ```
67    /// use ailloli_ui_widgets::{layout::Column, text::Text};
68    /// let column: Column<()> = Column::new().child(Text::new("row"));
69    /// let _ = column;
70    /// ```
71    pub fn child(mut self, child: impl IntoView<A>) -> Self {
72        self.children.push(child.into_view());
73        self
74    }
75}
76
77/// Converts declarative flex state and children into retained layout wrappers.
78impl<A: 'static> IntoView<A> for Column<A> {
79    fn into_view(self) -> View<A> {
80        let items: Vec<_> = self.children.iter().map(|c| c.flex_item).collect();
81        let child_hints: Vec<_> = self.children.iter().map(|c| c.size_hint).collect();
82        let widget = FlexWidget {
83            layout: layout_sizing_only(self.layout),
84            flex: self.flex,
85            items,
86            child_hints,
87        };
88        let content = View::node(widget, self.children);
89        let content = apply_margin_padding(content, layout_insets_only(self.layout));
90        finish_view_sized(
91            content,
92            self.flex_item,
93            LayoutSizeHint::from_layout(self.layout),
94        )
95    }
96}