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-popup]
16//! - [tui-prompts]
17//! - [tui-qrcode]
18//! - [tui-scrollbar]
19//! - [tui-scrollview]
20//!
21//! The widget crates are also available as standalone crates.
22//!
23//! # Screenshots
24//!
25//! ## [tui-bar-graph]
26//!
27//! [![Braille Rainbow](https://vhs.charm.sh/vhs-1sx9Ht6NzU6e28Cl51jJVv.gif)][tui-bar-graph]
28//!
29//! ## [tui-big-text]
30//!
31//! [![Demo](https://vhs.charm.sh/vhs-7DFJFGwBEnUjjLCFSqwEm9.gif)][tui-big-text]
32//!
33//! ## [tui-box-text]
34//!
35//! [![Demo](https://vhs.charm.sh/vhs-6ldj2r9v3mIaSzk8H7Jp8t.gif)][tui-box-text]
36//!
37//! ## [tui-cards]
38//!
39//! [![Demo](https://vhs.charm.sh/vhs-34mhPM1Juk2XnnLTGpOtE9.gif)][tui-cards]
40//!
41//! ## [tui-popup]
42//!
43//! [![Demo](https://vhs.charm.sh/vhs-q5Kz0QP3zmrBlQ6dofjMh.gif)][tui-popup]
44//!
45//! ## [tui-prompts]
46//!
47//! [![Text Prompt](https://vhs.charm.sh/vhs-7gLcGtWJWDlQZqcMlhrpRG.gif)][tui-prompts]
48//!
49//! ## [tui-qrcode]
50//!
51//! [![Demo](https://vhs.charm.sh/vhs-nUpcmCP1igCcGoJ5iio07.gif)][tui-qrcode]
52//!
53//! ## [tui-scrollview]
54//!
55//! [![Demo](https://vhs.charm.sh/vhs-6PuT3pdwSTp4aTvKrCBx9F.gif)][tui-scrollview]
56//!
57//! [tui-widgets]: https://crates.io/crates/tui-widgets
58//! [tui-bar-graph]: https://crates.io/crates/tui-bar-graph
59//! [tui-big-text]: https://crates.io/crates/tui-big-text
60//! [tui-box-text]: https://crates.io/crates/tui-box-text
61//! [tui-cards]: https://crates.io/crates/tui-cards
62//! [tui-popup]: https://crates.io/crates/tui-popup
63//! [tui-prompts]: https://crates.io/crates/tui-prompts
64//! [tui-qrcode]: https://crates.io/crates/tui-qrcode
65//! [tui-scrollbar]: https://crates.io/crates/tui-scrollbar
66//! [tui-scrollview]: https://crates.io/crates/tui-scrollview
67#![doc = document_features::document_features!()]
68
69#[cfg(feature = "bar-graph")]
70#[doc(inline)]
71pub use tui_bar_graph as bar_graph;
72#[cfg(feature = "big-text")]
73#[doc(inline)]
74pub use tui_big_text as big_text;
75#[cfg(feature = "box-text")]
76#[doc(inline)]
77pub use tui_box_text as box_text;
78#[cfg(feature = "cards")]
79#[doc(inline)]
80pub use tui_cards as cards;
81#[cfg(feature = "popup")]
82#[doc(inline)]
83pub use tui_popup as popup;
84#[cfg(feature = "prompts")]
85#[doc(inline)]
86pub use tui_prompts as prompts;
87#[cfg(feature = "qrcode")]
88#[doc(inline)]
89pub use tui_qrcode as qrcode;
90#[cfg(feature = "scrollbar")]
91#[doc(inline)]
92pub use tui_scrollbar as scrollbar;
93#[cfg(feature = "scrollview")]
94#[doc(inline)]
95pub use tui_scrollview as scrollview;