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