tui-lipan 0.2.0

Opinionated, component-based TUI framework for Rust - declarative components, reconciliation, layout engine, focus, overlays, and rich widgets on top of ratatui.
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

/// Options controlling semantic widget extraction from the node tree.
#[derive(Clone, Debug, PartialEq, Eq)]
pub struct UiSnapshotOptions {
    /// Include zero-area layout nodes.
    pub include_zero_area: bool,
    /// Include spacers and empty dividers.
    pub include_chrome: bool,
    /// Maximum list/table item labels emitted per widget.
    pub max_list_items: usize,
}

#[allow(clippy::derivable_impls)]
impl Default for UiSnapshotOptions {
    fn default() -> Self {
        Self {
            include_zero_area: false,
            include_chrome: false,
            max_list_items: 20,
        }
    }
}

impl UiSnapshotOptions {
    /// Returns diagnostic options for clipped, zero-area, or flex layout debugging.
    ///
    /// This includes zero-area nodes plus chrome widgets such as spacers and dividers,
    /// while keeping the default list/table preview limit.
    pub fn diagnostic() -> Self {
        Self {
            include_zero_area: true,
            include_chrome: true,
            ..Self::default()
        }
    }
}

/// Options for JSON/markdown export formatting.
#[derive(Clone, Debug, PartialEq, Eq, Default)]
pub struct UiSnapshotFormatOptions {
    /// Include the full captured cell buffer in JSON export.
    pub include_cells: bool,
}

/// File format for queued live-app snapshot export.
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum UiSnapshotFileFormat {
    /// Markdown report (always available).
    Markdown,
    /// JSON export (`ui-snapshot-json` feature).
    #[cfg(feature = "ui-snapshot-json")]
    Json,
    /// PNG image export (`ui-snapshot-png` feature).
    #[cfg(feature = "ui-snapshot-png")]
    Png,
}

#[allow(clippy::derivable_impls)]
impl Default for UiSnapshotFileFormat {
    fn default() -> Self {
        #[cfg(feature = "ui-snapshot-json")]
        {
            Self::Json
        }
        #[cfg(not(feature = "ui-snapshot-json"))]
        {
            Self::Markdown
        }
    }
}

impl UiSnapshotFileFormat {
    /// Route a snapshot path to a format by file extension.
    ///
    /// Returns [`Self::Json`] for `.json` and [`Self::Png`] for `.png` when the
    /// matching feature is enabled, and [`Self::Markdown`] for anything else -
    /// including a `.png` path in a build without `ui-snapshot-png`, so a missing
    /// feature degrades to a readable report instead of failing.
    pub fn from_path(path: &std::path::Path) -> Self {
        let Some(extension) = path.extension() else {
            return Self::Markdown;
        };
        if extension.eq_ignore_ascii_case("json") {
            #[cfg(feature = "ui-snapshot-json")]
            {
                return Self::Json;
            }
        }
        if extension.eq_ignore_ascii_case("png") {
            #[cfg(feature = "ui-snapshot-png")]
            {
                return Self::Png;
            }
        }
        Self::Markdown
    }
}