tui-pages 0.7.0

Coordination runtime for keyboard-driven, page-based TUI applications: input sequences, command resolution, focus, navigation, buffers, and panes.
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

//! Dialog content and result types.

/// The content of a modal dialog.
///
/// `D` is an application-owned "purpose" payload (often an enum) that the app
/// uses to tell apart which dialog was answered. It is opaque to the library.
///
/// `DialogData` is stored as the focus manager's dialog payload via
/// [`DialogData::show_intent`](crate::dialog::DialogData::show_intent); the
/// focus manager tracks which button is active and navigates between them.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct DialogData<D = ()> {
    pub title: String,
    pub message: String,
    pub buttons: Vec<String>,
    pub purpose: Option<D>,
    pub is_loading: bool,
}

impl<D> DialogData<D> {
    /// A dialog with a title, message, selectable buttons, and a purpose used
    /// to interpret the selection.
    pub fn new(
        title: impl Into<String>,
        message: impl Into<String>,
        buttons: impl IntoIterator<Item = impl Into<String>>,
        purpose: D,
    ) -> Self {
        Self {
            title: title.into(),
            message: message.into(),
            buttons: buttons.into_iter().map(Into::into).collect(),
            purpose: Some(purpose),
            is_loading: false,
        }
    }

    /// A buttonless "please wait" dialog. Replace it with [`DialogData::new`]
    /// (via [`show_intent`](DialogData::show_intent)) once the work completes.
    pub fn loading(title: impl Into<String>, message: impl Into<String>) -> Self {
        Self {
            title: title.into(),
            message: message.into(),
            buttons: Vec::new(),
            purpose: None,
            is_loading: true,
        }
    }

    pub fn button_count(&self) -> usize {
        self.buttons.len()
    }
}

/// The outcome of a dialog interaction.
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum DialogResult<D> {
    /// The dialog was closed without choosing a button (e.g. a loading dialog,
    /// or one dismissed with Esc).
    Dismissed,
    /// A button was chosen. `purpose` is the dialog's payload; `index` is which
    /// button (0-based, left to right).
    Selected { purpose: Option<D>, index: usize },
}