ntui 0.3.2

An Ink-style TUI library for Rust: components, hooks, flexbox layout, and fullscreen rendering.
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

// `Element` and `Hooks` are referenced in the `#[component]` fn signatures
// below at the source-text level, but the macro re-quotes those signature
// positions using fully-qualified `::ntui::Element` / `::ntui::Hooks` paths
// rather than the user's local idents, so rustc sees these two imports as
// structurally unused despite being semantically required by the surface
// syntax the macro accepts.
#[allow(unused_imports)]
use ntui::{Element, FlexDirection, Hooks, Node, component, element};

#[derive(Clone, PartialEq, Default)]
struct BadgeProps {
    label: String,
}

/// Renders a bracketed label, e.g. `[hello]`.
#[component]
fn Badge(props: &BadgeProps, _hooks: &mut Hooks) -> Element {
    element! { Text(content: format!("[{}]", props.label)) }
}

#[component]
fn NoProps(_hooks: &mut Hooks) -> Element {
    element! { Text(content: "static") }
}

#[test]
#[allow(clippy::useless_vec)]
fn element_macro_builds_hosts_components_keys_and_splices() {
    let items = vec!["x", "y"];
    let el = element! {
        View(flex_direction: FlexDirection::Column, gap: (1)) {
            Badge(label: "hello", key: "b1")
            NoProps
            #(items.iter().map(|i| element! { Text(content: *i, key: *i) }))
        }
    };
    let Node::View { props, children } = &el.node else {
        panic!("expected View")
    };
    assert_eq!(props.gap, 1);
    assert_eq!(children.len(), 4);
    assert_eq!(children[0].key.as_deref(), Some("b1"));
    assert!(matches!(children[1].node, Node::Component(_)));
    assert_eq!(children[2].key.as_deref(), Some("x"));
}

#[test]
fn bare_component_form_works_as_render_root() {
    let el = element!(NoProps);
    assert!(matches!(el.node, Node::Component(_)));
}

#[test]
#[rustfmt::skip] // rustfmt would rewrite the explicit form into shorthand, gutting the comparison
fn prop_field_shorthand_matches_explicit_form() {
    // `Badge(label)` must mean `Badge(label: label)` — rustfmt normalizes
    // struct-literal-shaped macro bodies toward shorthand, so the macro
    // has to accept what rustfmt writes.
    let label = String::from("hello");
    let shorthand = element!(Badge(label));
    let label = String::from("hello");
    let explicit = element!(Badge(label: label));
    let (Node::Component(a), Node::Component(b)) = (&shorthand.node, &explicit.node) else {
        panic!("expected components")
    };
    assert!(a.props_eq(b.as_ref()));
}