rnk 0.17.3

A React-like declarative terminal UI framework for Rust, inspired by Ink
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

//! Rendering system
//!
//! This module provides the core rendering infrastructure for rnk:
//!
//! - **App**: The main application runner
//! - **AppBuilder**: Fluent API for configuring apps
//! - **Terminal**: Low-level terminal abstraction
//! - **Output**: Virtual output buffer for rendering
//!
//! ## Render Modes
//!
//! rnk supports two rendering modes:
//!
//! - **Inline mode** (default): Output appears at current cursor position,
//!   persists in terminal history. Like Ink and Bubbletea's default.
//!
//! - **Fullscreen mode**: Uses alternate screen buffer, content is cleared
//!   on exit. Like vim or Bubbletea's `WithAltScreen()`.
//!
//! ## Example
//!
//! ```ignore
//! use rnk::prelude::*;
//!
//! // Inline mode (default)
//! render(my_app).run()?;
//!
//! // Fullscreen mode
//! render(my_app).fullscreen().run()?;
//! ```

mod app;
mod builder;
pub(crate) mod element_renderer;
mod filter;
mod frame_rate;
mod output;
pub(crate) mod registry;
pub(crate) mod render_to_string;
pub(crate) mod runtime;
pub(crate) mod static_content;
mod terminal;
pub(crate) mod tree_renderer;

// Core App type
pub use app::App;

// Builder and options
pub use builder::{AppBuilder, AppOptions, CancelToken, render, render_fullscreen, render_inline};

// Registry APIs
pub use registry::{
    IntoPrintable, ModeSwitch, Printable, RenderHandle, enter_alt_screen, exit_alt_screen,
    is_alt_screen, println, println_trimmed, render_handle, request_render,
};

// Element rendering APIs
pub use render_to_string::{
    render_to_string, render_to_string_auto, render_to_string_no_trim, render_to_string_raw,
};

// Frame rate control
pub use frame_rate::{FrameRateConfig, FrameRateController, FrameRateStats, SharedFrameRateStats};

// Event filtering
pub use filter::{EventFilter, FilterChain, FilterResult};

// Terminal and output
pub use output::{ClipRegion, Output};
pub use terminal::Terminal;