egui-macview 0.3.1

Cross-platform macOS AppKit Layout Engine, Authentic Control Primitive Suite, and CoreAnimation Physics Runtime for egui on Windows 11, macOS, Linux, and Web.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105

//! Authentic macOS AppKit Form Layout (`MacForm`).
//!
//! Compact wrapper around `egui::Grid` with AppKit token spacing,
//! trailing-aligned labels (column 0), and leading-aligned controls (column 1).

use crate::theme::MacTheme;
use egui::{vec2, Align, IdSalt, Layout, Response, Ui, Vec2, WidgetText};

/// Authentic macOS AppKit 2-column Form container.
pub struct MacForm<'a> {
    id_salt: IdSalt,
    theme: Option<&'a MacTheme>,
    spacing: Option<Vec2>,
    min_col_width: Option<f32>,
}

impl<'a> MacForm<'a> {
    /// Creates a new `MacForm` with the specified id salt.
    pub fn new(id_salt: impl egui::AsIdSalt) -> Self {
        Self {
            id_salt: IdSalt::new(id_salt),
            theme: None,
            spacing: None,
            min_col_width: None,
        }
    }

    /// Sets the dynamic theme to derive AppKit token spacing.
    pub fn theme(mut self, theme: &'a MacTheme) -> Self {
        self.theme = Some(theme);
        self
    }

    /// Overrides inter-item spacing between columns and rows in points.
    pub fn spacing(mut self, spacing: impl Into<Vec2>) -> Self {
        self.spacing = Some(spacing.into());
        self
    }

    /// Overrides the minimum column width in points.
    pub fn min_col_width(mut self, min_col_width: f32) -> Self {
        self.min_col_width = Some(min_col_width);
        self
    }

    /// Renders the form contents with trailing labels and leading controls.
    pub fn show<R>(self, ui: &mut Ui, add_contents: impl FnOnce(&mut MacFormUi<'_>) -> R) -> R {
        let spacing = self.spacing.unwrap_or_else(|| {
            let s = self
                .theme
                .map(|t| t.stack_view().default_spacing.points())
                .unwrap_or_else(|| ui.spacing().item_spacing.x);
            vec2(s, s)
        });

        let mut result = None;
        let mut grid = egui::Grid::new(self.id_salt)
            .num_columns(2)
            .spacing(spacing);
        if let Some(min_w) = self.min_col_width {
            grid = grid.min_col_width(min_w);
        }
        grid.show(ui, |grid_ui| {
            let mut form_ui = MacFormUi { ui: grid_ui };
            result = Some(add_contents(&mut form_ui));
        });
        result.expect("MacForm grid rendered")
    }
}

/// Form builder context for adding rows with trailing labels and leading controls.
pub struct MacFormUi<'a> {
    /// Underlying egui `Ui` instance.
    pub ui: &'a mut Ui,
}

impl<'a> MacFormUi<'a> {
    /// Adds a row with a trailing-aligned label (col 0) and leading-aligned control (col 1).
    pub fn row<R1, R2>(
        &mut self,
        label: impl FnOnce(&mut Ui) -> R1,
        control: impl FnOnce(&mut Ui) -> R2,
    ) -> (R1, R2) {
        let r1 = self
            .ui
            .with_layout(Layout::right_to_left(Align::Center), label)
            .inner;
        let r2 = self
            .ui
            .with_layout(Layout::left_to_right(Align::Center), control)
            .inner;
        self.ui.end_row();
        (r1, r2)
    }

    /// Convenience helper adding a text label and control row.
    pub fn row_label<R>(
        &mut self,
        label_text: impl Into<WidgetText>,
        control: impl FnOnce(&mut Ui) -> R,
    ) -> (Response, R) {
        let text = label_text.into();
        self.row(|ui| ui.label(text), control)
    }
}