ratatui_widgets/
lib.rs

1//! # Ratatui-widgets
2//!
3//! Please note: this crate is deprecated so that we can use the name for an internal Ratatui widget
4//! crate. Please use [tui-framework-experiment] instead.
5//!
6//! [tui-framework-experiment]: https://crates.io/crates/tui-framework-experiment
7//!
8//! [![Crates.io Badge]][Crate] [![License Badge]](#license) [![Docs.rs Badge]][API Docs]<br>
9//! [![Deps.rs Badge]][Dependencies] [![Codecov.io Badge]][Coverage] [![Discord Badge]][Ratatui
10//! Discord]
11//!
12//! `ratatui-widgets` is a Rust crate with extra widgets for [Ratatui].
13//!
14//! ## Installation
15//!
16//! ```shell
17//! cargo add ratatui-widgets
18//! ```
19//!
20//! ## Usage
21//!
22//! ```rust
23//! // TODO: Add usage examples
24//! ```
25//!
26//! ## Example
27//!
28//! ![Button](https://vhs.charm.sh/vhs-MSE5G9byLklG23xdJwbqR.gif)
29//!
30//! [Crates.io Badge]: https://img.shields.io/crates/v/ratatui-widgets?logo=rust&style=for-the-badge
31//! [License Badge]: https://img.shields.io/crates/l/ratatui-widgets?style=for-the-badge
32//! [Docs.rs Badge]: https://img.shields.io/docsrs/ratatui-widgets?logo=rust&style=for-the-badge
33//! [Deps.rs Badge]:
34//!     https://deps.rs/repo/github/joshka/ratatui-widgets/status.svg?style=for-the-badge
35//! [Codecov.io Badge]:
36//!     https://img.shields.io/codecov/c/github/joshka/ratatui-widgets?logo=codecov&style=for-the-badge&token=BAQ8SOKEST
37//! [Discord Badge]:
38//!     https://img.shields.io/discord/1070692720437383208?label=ratatui+discord&logo=discord&style=for-the-badge
39//!
40//! [Crate]: https://crates.io/crates/ratatui-widgets
41//! [API Docs]: https://docs.rs/crate/ratatui-widgets/
42//! [Dependencies]: https://deps.rs/repo/github/joshka/ratatui-widgets
43//! [Coverage]: https://app.codecov.io/gh/joshka/ratatui-widgets
44//! [Ratatui Discord]: https://discord.gg/pMCEU9hNEj
45//!
46//! [Ratatui]: https://crates.io/crates/ratatui
47
48#[deprecated(note = "Use tui-framework-experiment instead")]
49pub mod button;
50#[deprecated(note = "Use tui-framework-experiment instead")]
51pub mod events;
52#[deprecated(note = "Use tui-framework-experiment instead")]
53pub mod stack_container;
54#[deprecated(note = "Use tui-framework-experiment instead")]
55pub mod toggle_switch;
56
57#[deprecated(note = "Use tui-framework-experiment instead")]
58pub use button::{Button, State as ButtonState, Theme as ButtonTheme};
59#[deprecated(note = "Use tui-framework-experiment instead")]
60pub use stack_container::StackContainer;