tui_widgets/
lib.rs

1//! A collection of useful widgets for building terminal user interfaces using [Ratatui].
2//!
3//! [Ratatui]: https://crates.io/crates/ratatui
4//!
5//! This is a crate that combines multiple previously standalone crates into one in order simplify
6//! maintenance and to make it easier to use the widgets together.
7//!
8//! Workspace crates:
9//!
10//! - [tui-widgets] (this crate)
11//! - [tui-bar-graph]
12//! - [tui-big-text]
13//! - [tui-box-text]
14//! - [tui-cards]
15//! - [tui-equalizer]
16//! - [tui-popup]
17//! - [tui-prompts]
18//! - [tui-qrcode]
19//! - [tui-scrollbar]
20//! - [tui-scrollview]
21//!
22//! The widget crates are also available as standalone crates.
23//!
24//! # Screenshots
25//!
26//! ## [tui-bar-graph]
27//!
28//! [![Braille Rainbow](https://vhs.charm.sh/vhs-1sx9Ht6NzU6e28Cl51jJVv.gif)][tui-bar-graph]
29//!
30//! ## [tui-big-text]
31//!
32//! [![Demo](https://vhs.charm.sh/vhs-7DFJFGwBEnUjjLCFSqwEm9.gif)][tui-big-text]
33//!
34//! ## [tui-box-text]
35//!
36//! [![Demo](https://vhs.charm.sh/vhs-6ldj2r9v3mIaSzk8H7Jp8t.gif)][tui-box-text]
37//!
38//! ## [tui-cards]
39//!
40//! [![Demo](https://vhs.charm.sh/vhs-34mhPM1Juk2XnnLTGpOtE9.gif)][tui-cards]
41//!
42//! ## [tui-equalizer]
43//!
44//! [![Demo](https://vhs.charm.sh/vhs-FiRQkkDAUEnH2BrPbUx5i.gif)][tui-equalizer]
45//!
46//! ## [tui-popup]
47//!
48//! [![Demo](https://vhs.charm.sh/vhs-q5Kz0QP3zmrBlQ6dofjMh.gif)][tui-popup]
49//!
50//! ## [tui-prompts]
51//!
52//! [![Text Prompt](https://vhs.charm.sh/vhs-7gLcGtWJWDlQZqcMlhrpRG.gif)][tui-prompts]
53//!
54//! ## [tui-qrcode]
55//!
56//! [![Demo](https://vhs.charm.sh/vhs-nUpcmCP1igCcGoJ5iio07.gif)][tui-qrcode]
57//!
58//! ## [tui-scrollview]
59//!
60//! [![Demo](https://vhs.charm.sh/vhs-6PuT3pdwSTp4aTvKrCBx9F.gif)][tui-scrollview]
61//!
62//! [tui-widgets]: https://crates.io/crates/tui-widgets
63//! [tui-bar-graph]: https://crates.io/crates/tui-bar-graph
64//! [tui-big-text]: https://crates.io/crates/tui-big-text
65//! [tui-box-text]: https://crates.io/crates/tui-box-text
66//! [tui-cards]: https://crates.io/crates/tui-cards
67//! [tui-equalizer]: https://crates.io/crates/tui-equalizer
68//! [tui-popup]: https://crates.io/crates/tui-popup
69//! [tui-prompts]: https://crates.io/crates/tui-prompts
70//! [tui-qrcode]: https://crates.io/crates/tui-qrcode
71//! [tui-scrollbar]: https://crates.io/crates/tui-scrollbar
72//! [tui-scrollview]: https://crates.io/crates/tui-scrollview
73#![doc = document_features::document_features!()]
74
75#[cfg(feature = "bar-graph")]
76#[doc(inline)]
77pub use tui_bar_graph as bar_graph;
78#[cfg(feature = "big-text")]
79#[doc(inline)]
80pub use tui_big_text as big_text;
81#[cfg(feature = "box-text")]
82#[doc(inline)]
83pub use tui_box_text as box_text;
84#[cfg(feature = "cards")]
85#[doc(inline)]
86pub use tui_cards as cards;
87#[cfg(feature = "equalizer")]
88#[doc(inline)]
89pub use tui_equalizer as equalizer;
90#[cfg(feature = "popup")]
91#[doc(inline)]
92pub use tui_popup as popup;
93#[cfg(feature = "prompts")]
94#[doc(inline)]
95pub use tui_prompts as prompts;
96#[cfg(feature = "qrcode")]
97#[doc(inline)]
98pub use tui_qrcode as qrcode;
99#[cfg(feature = "scrollbar")]
100#[doc(inline)]
101pub use tui_scrollbar as scrollbar;
102#[cfg(feature = "scrollview")]
103#[doc(inline)]
104pub use tui_scrollview as scrollview;
tui_widgets/lib.rs

tui_widgets/
lib.rs
