ntui 0.3.1

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

use std::any::{Any, TypeId};

use crate::element::Element;
use crate::hooks::Hooks;

/// A UI component: a pure function from `Props` and hook state to an
/// [`Element`] tree. Usually implemented via the `#[component]` attribute
/// macro rather than by hand.
pub trait Component: 'static {
    /// Input data for this component. Compared by value between renders to
    /// decide whether the component's subtree needs updating.
    type Props: Clone + PartialEq + Default + 'static;
    /// Produces this component's output tree for the current `props`,
    /// reading and updating hook state via `hooks`.
    fn render(props: &Self::Props, hooks: &mut Hooks) -> Element;
}

/// Object-safe erasure of (component type, props).
pub trait AnyComponent {
    fn component_type(&self) -> TypeId;
    fn name(&self) -> &'static str;
    fn render(&self, hooks: &mut Hooks) -> Element;
    fn props_eq(&self, other: &dyn AnyComponent) -> bool;
    fn as_any(&self) -> &dyn Any;
}

pub(crate) struct TypedComponent<C: Component> {
    pub props: C::Props,
    marker: std::marker::PhantomData<fn() -> C>,
}

impl<C: Component> TypedComponent<C> {
    pub fn new(props: C::Props) -> Self {
        TypedComponent {
            props,
            marker: std::marker::PhantomData,
        }
    }
}

impl<C: Component> AnyComponent for TypedComponent<C> {
    fn component_type(&self) -> TypeId {
        TypeId::of::<C>()
    }
    fn name(&self) -> &'static str {
        std::any::type_name::<C>()
    }
    fn render(&self, hooks: &mut Hooks) -> Element {
        C::render(&self.props, hooks)
    }
    fn props_eq(&self, other: &dyn AnyComponent) -> bool {
        other
            .as_any()
            .downcast_ref::<TypedComponent<C>>()
            .is_some_and(|o| o.props == self.props)
    }
    fn as_any(&self) -> &dyn Any {
        self
    }
}