romm-tui 1.5.0

Terminal UI for the RomM API
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

//! Layout helpers for the setup wizard screen.

use ratatui::layout::{Constraint, Direction, Layout, Rect};
use ratatui::text::{Line, Text};

use crate::tui::footer_hint::{footer_hint_line, FooterHintEntry};
use crate::tui::theme::RommStyles;
use romm_api::config::{read_user_config_json_from_disk, ExtrasDefaults};

use super::types::Step;

pub(crate) fn extras_defaults_from_disk() -> ExtrasDefaults {
    read_user_config_json_from_disk()
        .map(|c| c.extras_defaults)
        .unwrap_or_default()
}

pub(crate) fn wizard_layout(area: Rect, step: Step) -> [Rect; 3] {
    let top = if matches!(step, Step::Url) { 5 } else { 3 };
    let v = Layout::default()
        .direction(Direction::Vertical)
        .constraints([
            Constraint::Length(top),
            Constraint::Min(6),
            Constraint::Length(4),
        ])
        .split(area);
    [v[0], v[1], v[2]]
}

const WIZARD_URL_HINTS: &[FooterHintEntry] = &[
    FooterHintEntry {
        key: "Backspace",
        label: "Delete",
    },
    FooterHintEntry {
        key: "Enter",
        label: "Next",
    },
];

const WIZARD_HTTPS_HINTS: &[FooterHintEntry] = &[
    FooterHintEntry {
        key: "Space",
        label: "Toggle",
    },
    FooterHintEntry {
        key: "Enter",
        label: "Next",
    },
];

const WIZARD_DOWNLOAD_HINTS: &[FooterHintEntry] = &[
    FooterHintEntry {
        key: "Ctrl+Enter",
        label: "Next",
    },
    FooterHintEntry {
        key: "↑",
        label: "Path bar",
    },
    FooterHintEntry {
        key: "Tab",
        label: "Path/list",
    },
];

const WIZARD_NEXT_HINTS: &[FooterHintEntry] = &[FooterHintEntry {
    key: "Enter",
    label: "Next",
}];

const WIZARD_AUTH_FIELD_HINTS: &[FooterHintEntry] = &[
    FooterHintEntry {
        key: "Tab",
        label: "Switch field",
    },
    FooterHintEntry {
        key: "Enter",
        label: "Next",
    },
];

const WIZARD_NEXT_STEP_HINTS: &[FooterHintEntry] = &[FooterHintEntry {
    key: "Enter",
    label: "Next step",
}];

const WIZARD_SUMMARY_HINTS: &[FooterHintEntry] = &[FooterHintEntry {
    key: "Enter",
    label: "Connect & save",
}];

pub(crate) fn wizard_footer_entries(step: Step) -> &'static [FooterHintEntry] {
    match step {
        Step::Url => WIZARD_URL_HINTS,
        Step::Https => WIZARD_HTTPS_HINTS,
        Step::Download => WIZARD_DOWNLOAD_HINTS,
        Step::CustomConsolePaths | Step::AuthMenu => WIZARD_NEXT_HINTS,
        Step::BasicUser | Step::BasicPass => WIZARD_AUTH_FIELD_HINTS,
        Step::Bearer | Step::PairingCode => WIZARD_NEXT_STEP_HINTS,
        Step::ApiHeader | Step::ApiKey => WIZARD_AUTH_FIELD_HINTS,
        Step::Summary => WIZARD_SUMMARY_HINTS,
    }
}

pub(crate) fn wizard_footer_text(
    entries: &[FooterHintEntry],
    inner_width: u16,
    styles: &RommStyles<'_>,
) -> Text<'static> {
    let ver = format!("romm-cli {}", env!("CARGO_PKG_VERSION"));
    Text::from(vec![
        footer_hint_line(entries, inner_width, styles),
        Line::from(ver).style(styles.muted()),
    ])
}