ratcn 0.0.1

Themeable terminal UI components and interaction runtime for Ratatui
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

//! Integration tests for the public render and event-routing entry points.

use ratatui::{Terminal, backend::TestBackend};
use ratcn::runtime::{
    ChildId, Component, Event, EventResult, FocusState, KeyCode, KeyEvent, Ratcn, RenderCtx,
    ScopeOptions,
};
use ratcn::{Dialog, Theme};

#[derive(Default)]
struct State {
    focus: FocusState,
    marker: u8,
}

#[derive(Debug, Clone, PartialEq)]
enum Msg {
    Focus(FocusState),
    Activated,
}

struct Probe;

impl Component<State, Msg> for Probe {
    fn render(&mut self, ctx: &mut RenderCtx<'_, '_, State, Msg>) {
        assert_eq!(ctx.state().marker, 7);
        let area = ctx.area();
        ctx.with_buffer(|buf| assert!(buf.area.width >= area.width));
    }

    fn handle_event(
        &mut self,
        event: &Event,
        _state: &State,
        _ctx: &mut ratcn::runtime::EventCtx<'_>,
    ) -> EventResult<Msg> {
        if matches!(event, Event::Key(key) if key.code == KeyCode::Enter) {
            EventResult::Emit(Msg::Activated)
        } else {
            EventResult::Ignored
        }
    }

    fn is_focusable(&self, _state: &State) -> bool {
        true
    }
}

#[test]
fn unified_render_apis_are_usable_from_an_external_crate() {
    let state = State {
        marker: 7,
        ..State::default()
    };
    let mut ratcn = Ratcn::new().focus(|state: &State| &state.focus, Msg::Focus);
    let mut terminal = Terminal::new(TestBackend::new(40, 10)).expect("terminal");
    let theme = Theme::default_dark();

    terminal
        .draw(|frame| {
            let area = frame.area();
            ratcn.render(frame, &state, &theme, |ctx| {
                ctx.scope(
                    ChildId::Static("view"),
                    area,
                    ScopeOptions::default(),
                    |ctx| ctx.render_component(ChildId::Static("probe"), Probe, ctx.area()),
                );
                ctx.modal(
                    ChildId::Static("dialog"),
                    Dialog::<State, Msg>::new().content(1, |ctx| {
                        ctx.render_component(ChildId::Static("probe"), Probe, ctx.area());
                    }),
                    area,
                );
            });
        })
        .expect("draw");

    assert_eq!(
        ratcn.handle_event(Event::Key(KeyEvent::new(KeyCode::Enter)), &state),
        EventResult::Emit(Msg::Activated)
    );
}