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
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

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

use serde::{Deserialize, Serialize};

use crate::node::{Common, IntoNode, Node};
use crate::style::Style;

/// Scrollbar orientation and edge.
#[derive(Clone, Copy, Debug, Default, PartialEq, Eq, Hash, Serialize, Deserialize)]
pub enum ScrollbarOrientation {
    /// Vertical, right edge (ratatui default).
    #[default]
    VerticalRight,
    /// Vertical, left edge.
    VerticalLeft,
    /// Horizontal, bottom edge.
    HorizontalBottom,
    /// Horizontal, top edge.
    HorizontalTop,
}

/// ratatui `ScrollbarState`.
#[derive(Clone, Debug, Default, PartialEq, Eq, Hash, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct ScrollbarState {
    /// Total content length.
    pub content_length: u32,
    /// Current position.
    pub position: u32,
    /// Viewport length (derived from the area when absent).
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub viewport_content_length: Option<u32>,
}

impl ScrollbarState {
    /// State over the given content length.
    #[must_use]
    pub fn new(content_length: u32) -> Self {
        Self {
            content_length,
            position: 0,
            viewport_content_length: None,
        }
    }

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

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

/// ratatui `Scrollbar` (§4.5.1): a read-only position indicator; scrollable
/// widgets use their own native `scrollbar` flag instead.
#[derive(Clone, Debug, Default, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct Scrollbar {
    /// Common node props (`key`, `style`, `block`, `fallback`).
    #[serde(flatten)]
    pub common: Common,
    /// Orientation (default `VerticalRight`).
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub orientation: Option<ScrollbarOrientation>,
    /// Content / position state.
    pub state: ScrollbarState,
    /// Thumb style.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub thumb_style: Option<Style>,
    /// Track style.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub track_style: Option<Style>,
    /// Begin symbol (`null` = none).
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub begin_symbol: Option<String>,
    /// End symbol (`null` = none).
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub end_symbol: Option<String>,
}

impl Scrollbar {
    /// A scrollbar over the given state.
    #[must_use]
    pub fn new(state: ScrollbarState) -> Self {
        Self {
            common: Common::new(),
            orientation: None,
            state,
            thumb_style: None,
            track_style: None,
            begin_symbol: None,
            end_symbol: None,
        }
    }

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

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

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

    /// Sets the begin symbol.
    #[must_use]
    pub fn begin_symbol(mut self, symbol: impl Into<String>) -> Self {
        self.begin_symbol = Some(symbol.into());
        self
    }

    /// Sets the end symbol.
    #[must_use]
    pub fn end_symbol(mut self, symbol: impl Into<String>) -> Self {
        self.end_symbol = Some(symbol.into());
        self
    }
}

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