oino-ui 1.0.0

Wire types and ratatui-mirroring builder for the Oino extension UI protocol v2 (serde-only, wasm32-wasip2-safe)
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

//! ratatui `Paragraph` (§4.5.1).

use serde::{Deserialize, Serialize};

use crate::node::{Common, IntoNode, Node};
use crate::text::{Alignment, Text};

/// Paragraph wrapping: `false` disables wrapping, `{trim: bool}` enables it
/// (ratatui `Wrap`).
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]
#[serde(untagged)]
pub enum Wrap {
    /// `false`: no wrapping, long lines scroll horizontally.
    Disabled(bool),
    /// ratatui `Wrap { trim }`.
    Enabled {
        /// Trim leading whitespace on wrapped lines (ratatui default `true`).
        trim: bool,
    },
}

impl Wrap {
    /// ratatui `Wrap { trim }`.
    #[must_use]
    pub fn trim(trim: bool) -> Self {
        Self::Enabled { trim }
    }
}

/// ratatui `Paragraph` (§4.5.1).
#[derive(Clone, Debug, Default, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct Paragraph {
    /// Common node props (`key`, `style`, `block`, `fallback`).
    #[serde(flatten)]
    pub common: Common,
    /// Paragraph text.
    pub text: Text,
    /// Wrapping (default `{trim: true}`).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub wrap: Option<Wrap>,
    /// Initial scroll offset `[y, x]` in rows / columns.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub scroll: Option<[u16; 2]>,
    /// Text alignment.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub alignment: Option<Alignment>,
    /// GUI extra: native scrollbar.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub scrollbar: Option<bool>,
}

impl Paragraph {
    /// A paragraph from any text-like value.
    #[must_use]
    pub fn new(text: impl Into<Text>) -> Self {
        Self {
            text: text.into(),
            ..Self::default()
        }
    }

    /// Sets wrapping.
    #[must_use]
    pub fn wrap(mut self, wrap: Wrap) -> Self {
        self.wrap = Some(wrap);
        self
    }

    /// Sets the initial scroll offset.
    #[must_use]
    pub fn scroll(mut self, y: u16, x: u16) -> Self {
        self.scroll = Some([y, x]);
        self
    }

    /// Sets the alignment.
    #[must_use]
    pub fn alignment(mut self, alignment: Alignment) -> Self {
        self.alignment = Some(alignment);
        self
    }

    /// GUI extra: native scrollbar.
    #[must_use]
    pub fn scrollbar(mut self, scrollbar: bool) -> Self {
        self.scrollbar = Some(scrollbar);
        self
    }
}

impl IntoNode for Paragraph {}
impl From<Paragraph> for Node {
    fn from(p: Paragraph) -> Self {
        Node::Paragraph(p)
    }
}

#[cfg(test)]
mod tests {
    #![allow(
        clippy::unwrap_used,
        clippy::expect_used,
        clippy::panic,
        reason = "tests assert by unwrapping"
    )]
    use super::*;

    #[test]
    fn wrap_false_form() {
        let w: Wrap = serde_json::from_str("false").expect("false parses");
        assert_eq!(w, Wrap::Disabled(false));
        let w: Wrap = serde_json::from_str(r#"{"trim":true}"#).expect("object parses");
        assert_eq!(w, Wrap::Enabled { trim: true });
    }
}