charmed-bubbles 0.2.0

Common TUI components for bubbletea applications
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

#![forbid(unsafe_code)]
// Allow pedantic lints for early-stage API ergonomics.
#![allow(clippy::doc_markdown)]
#![allow(clippy::missing_fields_in_debug)]
#![allow(clippy::nursery)]
#![allow(clippy::pedantic)]
#![allow(clippy::suspicious_operation_groupings)]

//! # Bubbles
//!
//! A collection of reusable TUI components for the Bubbletea framework.
//!
//! Bubbles provides ready-to-use components including:
//! - **cursor** - Text cursor with blinking support
//! - **spinner** - Animated loading indicators with multiple styles
//! - **timer** - Countdown timer with timeout notifications
//! - **stopwatch** - Elapsed time tracking
//! - **paginator** - Pagination for lists and tables
//! - **progress** - Progress bar with gradient and animation support
//! - **viewport** - Scrollable content viewport
//! - **help** - Help view for displaying key bindings
//! - **key** - Key binding definitions and matching
//! - **runeutil** - Input sanitization utilities
//! - **textinput** - Single-line text input with suggestions
//! - **textarea** - Multi-line text editor
//! - **table** - Data table with keyboard navigation
//! - **list** - Feature-rich filterable list
//! - **filepicker** - File system browser
//!
//! ## Role in `charmed_rust`
//!
//! Bubbles is the component layer that sits on top of bubbletea and lipgloss:
//! - **bubbletea** provides the runtime and message loop.
//! - **lipgloss** provides styling used by every component.
//! - **huh** and **glow** embed bubbles components directly.
//! - **demo_showcase** uses bubbles to demonstrate real-world UI composition.
//!
//! ## Example
//!
//! ```rust,ignore
//! use bubbles::spinner::{SpinnerModel, spinners};
//!
//! let spinner = SpinnerModel::with_spinner(spinners::dot());
//! let tick_msg = spinner.tick();
//! ```

pub mod cursor;
pub mod help;
pub mod key;
pub mod paginator;
pub mod progress;
pub mod runeutil;
pub mod spinner;
pub mod stopwatch;
pub mod textarea;
pub mod textinput;
pub mod timer;
pub mod viewport;

// Complex components
pub mod filepicker;
pub mod list;
pub mod table;

/// Prelude module for convenient imports.
pub mod prelude {
    pub use crate::cursor::{Cursor, Mode as CursorMode, blink_cmd};
    pub use crate::help::Help;
    pub use crate::key::{Binding, Help as KeyHelp, matches};
    pub use crate::paginator::{Paginator, Type as PaginatorType};
    pub use crate::progress::Progress;
    pub use crate::runeutil::Sanitizer;
    pub use crate::spinner::{Spinner, SpinnerModel, spinners};
    pub use crate::stopwatch::Stopwatch;
    pub use crate::textarea::TextArea;
    pub use crate::textinput::TextInput;
    pub use crate::timer::Timer;
    pub use crate::viewport::Viewport;

    // Complex components
    pub use crate::filepicker::{DirEntry, FilePicker, ReadDirErrMsg, ReadDirMsg};
    pub use crate::list::{DefaultDelegate, FilterState, Item, ItemDelegate, List};
    pub use crate::table::{Column, Row, Table};
}