rtb-tui 0.6.5

Reusable TUI widgets: forms, wizards, prompts, tables. Part of the phpboyscout Rust toolkit.
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

//! Reusable TUI building blocks for RTB-built CLI tools.
//!
//! Three pieces:
//!
//! - [`Wizard`] / [`WizardStep`] — multi-step interactive form with
//!   escape-to-back navigation, backed by [`inquire`].
//! - [`render_table`] / [`render_json`] — uniform structured-output
//!   helpers used by the v0.4 `rtb-cli` ops subtrees behind a global
//!   `--output text|json` flag.
//! - [`Spinner`] — TTY-aware progress indicator that no-ops when
//!   stderr isn't a terminal (CI logs, MCP transports).
//!
//! The original design contract is [spec 0020] on the rust-tool-base
//! wiki.
//!
//! [spec 0020]: https://gitlab.com/phpboyscout/rust-tool-base/-/wikis/specs/0020-rtb-tui-v0.1

#![forbid(unsafe_code)]

mod error;
mod render;
mod spinner;
mod wizard;

pub use error::{RenderError, WizardError};
pub use render::{render_json, render_table};
pub use spinner::Spinner;
pub use wizard::{StepOutcome, Wizard, WizardBuilder, WizardStep};

/// Re-export so downstream consumers (and `WizardStep` impls) can
/// `?`-propagate without adding `inquire` as a direct dependency.
pub use inquire::InquireError;

/// Re-export so a `render_table` row type derives the same `Tabled` this
/// crate bounds on. A second `tabled` version in the graph is a separate,
/// incompatible trait; derive with `#[tabled(crate = "rtb_tui::tabled")]`.
pub use tabled;