oxicode-vtui 0.68.0

Terminal UI framework for oxicode, based on vtcode-ui
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
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150

//! Layout system — responsive mode + agent view geometry.
//!
//! ## Modules
//!
//! | Module | Purpose |
//! |---|---|
//! | [`agent`] | `AgentViewLayout`, `ActivePane`, `PaneAreas` — pure geometry |
//! | [`config`] | `LayoutConfig`, `ScrollbarConfig` — appearance settings |
//! | [`status_bar`] | `StatusBar` + `StatusBarBuilder` — 1-row top bar |
//! | [`shortcuts_bar`] | `ShortcutsBar` + `HintItem` — bottom keyboard hints |
//! | [`welcome`] | `WelcomeLayout` — welcome screen geometry |
//!
//! The existing [`LayoutMode`] (ported from `vtcode-ui`) provides responsive
//! breakpoints.  The new `AgentViewLayout` provides the grok-build-style
//! pure-compute layout engine for the agent conversation view.

pub mod agent;
pub mod config;
pub mod shortcuts_bar;
pub mod status_bar;
pub mod welcome;

// ───────────────────────────────────────────────────────────────────────────
// Re-exports
// ───────────────────────────────────────────────────────────────────────────

pub use agent::{
    AUTO_COMPACT_MAX_ROWS, ActivePane, AgentViewLayout, LayoutInput, PaneAreas,
    SHORT_TERMINAL_ROWS, effective_compact,
};
pub use config::{LayoutConfig, ScrollbarConfig};
pub use shortcuts_bar::{
    CompactConfig, HintItem, PendingHint, ShortcutBarStyling, ShortcutsBar, compute_effective_hints,
};
pub use status_bar::{StatusBar, StatusBarBuilder, StatusBarStyling};
pub use welcome::{HERO_BOX_MIN_WIDTH, PROMPT_HEIGHT, WelcomeLayout, WelcomePromptFocus};

// ───────────────────────────────────────────────────────────────────────────
// LayoutMode (preserved from the original vtcode-ui port)
// ───────────────────────────────────────────────────────────────────────────

use ratatui::layout::Rect;

use crate::design::constants::{COMPACT_MAX_COLS, COMPACT_MAX_ROWS, WIDE_MIN_COLS, WIDE_MIN_ROWS};

/// Responsive layout mode based on terminal dimensions.
///
/// This enum provides a single source of truth for layout decisions
/// across the UI, enabling consistent responsive behavior.
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum LayoutMode {
    /// Minimal chrome for tiny terminals (< 80 cols or < 20 rows)
    Compact,
    /// Default layout for standard terminals
    Standard,
    /// Enhanced layout with sidebar for wide terminals (>= 120 cols, >= 24 rows)
    Wide,
}

impl LayoutMode {
    /// Determine layout mode from viewport dimensions.
    pub(crate) fn from_area(area: Rect) -> Self {
        if area.width <= COMPACT_MAX_COLS || area.height <= COMPACT_MAX_ROWS {
            LayoutMode::Compact
        } else if area.width >= WIDE_MIN_COLS && area.height >= WIDE_MIN_ROWS {
            LayoutMode::Wide
        } else {
            LayoutMode::Standard
        }
    }

    /// Check if borders should be shown.
    pub(crate) fn show_borders(self) -> bool {
        !matches!(self, LayoutMode::Compact)
    }

    /// Check if panel titles should be shown.
    pub(crate) fn show_titles(self) -> bool {
        !matches!(self, LayoutMode::Compact)
    }

    /// Check if sidebar can be shown.
    pub(crate) fn allow_sidebar(self) -> bool {
        matches!(self, LayoutMode::Wide)
    }

    /// Check if logs panel should be visible.
    pub(crate) fn show_logs_panel(self) -> bool {
        !matches!(self, LayoutMode::Compact)
    }

    /// Get the footer height for this mode.
    pub(crate) fn footer_height(self) -> u16 {
        0
    }

    /// Check if footer should be shown.
    pub(crate) fn show_footer(self) -> bool {
        false
    }

    /// Get the maximum header height as percentage of viewport.
    pub(crate) fn max_header_percent(self) -> f32 {
        match self {
            LayoutMode::Compact => 0.2,
            _ => 0.3,
        }
    }

    /// Get the sidebar width percentage (only meaningful in Wide mode).
    pub(crate) fn sidebar_width_percent(self) -> u16 {
        match self {
            LayoutMode::Wide => 25,
            _ => 0,
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn compact_mode_for_small_terminals() {
        assert_eq!(
            LayoutMode::from_area(Rect::new(0, 0, 60, 20)),
            LayoutMode::Compact
        );
        assert_eq!(
            LayoutMode::from_area(Rect::new(0, 0, 80, 15)),
            LayoutMode::Compact
        );
    }

    #[test]
    fn standard_mode_for_normal_terminals() {
        assert_eq!(
            LayoutMode::from_area(Rect::new(0, 0, 100, 22)),
            LayoutMode::Standard
        );
    }

    #[test]
    fn wide_mode_for_large_terminals() {
        assert_eq!(
            LayoutMode::from_area(Rect::new(0, 0, 140, 30)),
            LayoutMode::Wide
        );
    }
}