Skip to main content

rnk_icons/
lib.rs

1//! rnk-icons - Terminal icons library
2//!
3//! A collection of Nerd Font icons for terminal UI applications.
4//!
5//! # Example
6//!
7//! ```rust
8//! use rnk_icons::{Icon, icons};
9//!
10//! // Get a file icon
11//! let rust_icon = icons::file::rust();
12//! println!("{} main.rs", rust_icon);
13//!
14//! // Get a UI icon
15//! let folder = icons::ui::folder();
16//! println!("{} src/", folder);
17//!
18//! // With color (requires rnk or rnk-style)
19//! let icon = Icon::new(icons::file::rust()).colored("#DEA584");
20//! ```
21
22mod icon;
23pub mod icons;
24
25pub use icon::Icon;
26
27/// Prelude for convenient imports
28pub mod prelude {
29    pub use crate::icon::Icon;
30    pub use crate::icons;
31}