feather-tui 4.1.0

A crate for building simple terminal-based user interfaces.
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
85
86
87
88
89

//! Feather-Tui is a simple terminal UI library designed to provide building blocks
//! for text-based user interfaces. It started life as a small C library in my
//! school management system project, aiming to offer an easy-to-use UI framework
//! for terminal applications. Now, I’m rewriting it in Rust to learn the language
//! and (hopefully) improve both performance and maintainability.
//!
//! # Features
//!
//! - `shorten_mod_name` shortened aliases for common modules to reduce verbosity.
//!     - `components` → `cpn`
//!     - `callback` → `cbk`
//!     - `trigger` → `trg`
//!     - `container` → `con`
//!     - `renderer` → `ren`
//!     - `input` → `inp`
//!     - `error` → `err`
//! 
//! - `reduce_abstraction` flattens module paths to make the API more direct.
//!     - `feather_tui::components::Header` → `feather_tui::Header`
//!     - `feather_tui::renderer::Renderer` → `feather_tui::Renderer`
//!     - `feather_tui::input::key_char` → `feather_tui::key_char
//!     - ...

/// Core building blocks for constructing user interfaces.
pub mod components;
/// A generic callback handler for executing functions with stored arguments.
pub mod callback;
/// A generic trigger handler for evaluating conditions based on stored arguments.
pub mod trigger;
/// Acts as a layout manager for the UI elements.
pub mod container;
pub mod list;
/// Responsible for rendering the UI to the terminal.
pub mod renderer;
/// Handles user input, non-blocking key events, and key code conversions with crossterm.
pub mod input;
/// Provides custom error types and a result type alias for error handling in `Feather-TUI`.
pub mod error;

mod     util;

// Shorten modules name.

#[cfg(feature = "shorten_mod_name")]
pub use components as cpn;

#[cfg(feature = "shorten_mod_name")]
pub use callback as cbk;

#[cfg(feature = "shorten_mod_name")]
pub use trigger as trg;

#[cfg(feature = "shorten_mod_name")]
pub use container as con;

#[cfg(feature = "shorten_mod_name")]
pub use renderer as ren;

#[cfg(feature = "shorten_mod_name")]
pub use input as inp;

#[cfg(feature = "shorten_mod_name")]
pub use error as err;

// Reducing abstraction.

#[cfg(feature = "reduce_abstraction")]
pub use components::{Header, Option, Text, TextFlags, Separator, SeparatorStyle, Selector};

#[cfg(feature = "reduce_abstraction")]
pub use callback::Callback;

#[cfg(feature = "reduce_abstraction")]
pub use trigger::Trigger;

#[cfg(feature = "reduce_abstraction")]
pub use container::{Container, ContainerBuilder};

#[cfg(feature = "reduce_abstraction")]
pub use list::{List, ListBuilder};

#[cfg(feature = "reduce_abstraction")]
pub use renderer::{ready, unready, Renderer};

#[cfg(feature = "reduce_abstraction")]
pub use input::{line, key, keycode_to_char, key_char};

#[cfg(feature = "reduce_abstraction")]
pub use error::{FtuiError, FtuiResult};