mirror of
https://github.com/ratatui/ratatui.git
synced 2025-12-29 21:01:16 +00:00
5ad623c29b
This helps make the doc examples more explicit about what is being used. It will also makes it a bit easier to do future refactoring of Ratatui, into several crates, as the ambiguity of where types are coming from will be reduced. Additionally, several doc examples have been simplified to use Stylize, and necessary imports are no longer hidden. This doesn't remove the prelude. Only the internal usages.
36 lines
1.1 KiB
Rust
36 lines
1.1 KiB
Rust
//! A prelude for conveniently writing applications using this library.
|
|
//!
|
|
//! ```rust,no_run
|
|
//! use ratatui::prelude::*;
|
|
//! ```
|
|
//!
|
|
//! Aside from the main types that are used in the library, this prelude also re-exports several
|
|
//! modules to make it easy to qualify types that would otherwise collide. E.g.:
|
|
//!
|
|
//! ```rust
|
|
//! use ratatui::{prelude::*, widgets::*};
|
|
//!
|
|
//! #[derive(Debug, Default, PartialEq, Eq)]
|
|
//! struct Line;
|
|
//!
|
|
//! assert_eq!(Line::default(), Line);
|
|
//! assert_eq!(text::Line::default(), ratatui::text::Line::from(vec![]));
|
|
//! ```
|
|
|
|
#[cfg(feature = "crossterm")]
|
|
pub use crate::backend::CrosstermBackend;
|
|
#[cfg(all(not(windows), feature = "termion"))]
|
|
pub use crate::backend::TermionBackend;
|
|
#[cfg(feature = "termwiz")]
|
|
pub use crate::backend::TermwizBackend;
|
|
pub use crate::{
|
|
backend::{self, Backend},
|
|
buffer::{self, Buffer},
|
|
layout::{self, Alignment, Constraint, Direction, Layout, Margin, Position, Rect, Size},
|
|
style::{self, Color, Modifier, Style, Stylize},
|
|
symbols::{self},
|
|
text::{self, Line, Masked, Span, Text},
|
|
widgets::{block::BlockExt, StatefulWidget, Widget},
|
|
Frame, Terminal,
|
|
};
|