This crate allows you to style te terminal cross-platform. It supports all UNIX and windows terminals down to windows 7 (not all terminals are tested see Tested Terminals for more info)
This crate is a sub-crate of crossterm to style te terminal, and can be use individually.
Other sub-crates are: - Crossterm Input - Crossterm Terminal - Crossterm Screen - Crossterm Cursor
When you want to use other modules as well you might want to use crossterm with feature flags
This documentation is only for crossterm_style version 0.1 if you have an older version I suggest you check the Upgrade Manual. Also, check out the examples folders with detailed examples for all functionality of this crate.
Add the crossterm_style package to your Cargo.toml file.
``
[dependencies]
crossterm_style` = "0.1"
``
And import thecrossterm_style` modules you want to use.
```rust
extern crate crossterm_style;
pub use crossterm_style::{color, style, Attribute, Color, ColorType, ObjectStyle, StyledObject, TerminalColor}; ```
These are the features of this crate:
Check out the examples for more information about how to use this crate.
style font with attributes ```rust use crossterm_style::{Colored, Color, Colorize, Styler, Attribute};
// pass any Attribute value to the formatting braces.
println!("{} Underlined {} No Underline", Attribute::Underlined, Attribute::NoUnderline);
// you could also call different attribute methods on a &str and keep on chaining if needed.
let styledtext = "Bold Underlined".bold().underlined();
println!("{}", styledtext);
// old-way but still usable let styled_text = style("Bold Underlined").bold().underlined(); ```
style font with colors ```rust use crossterm_style::{Colored, Color, Colorize};
println!("{} Red foreground color", Colored::Fg(Color::Red)); println!("{} Blue background color", Colored::Bg(Color::Blue));
// you can also call different coloring methods on a &str.
let styledtext = "Bold Underlined".red().onblue();
println!("{}", styled_text);
// old-way but still usable
let styled_text = style("Bold Underlined").with(Color::Red).on(Color::Blue);
_style font with RGB and ANSI Value_
rust
// custom rgb value (Windows 10 and UNIX systems)
println!("{} some colored text", Colored::Fg(Color::Rgb {
r: 10,
g: 10,
b: 10
}));
// custom ansi color value (Windows 10 and UNIX systems) println!("{} some colored text", Colored::Fg(Color::AnsiValue(10)));
```
This crate supports all Unix terminals and windows terminals down to Windows 7 but not all of them have been tested. If you have used this library for a terminal other than the above list without issues feel free to add it to the above list, I really would appreciate it.
This library is average stable now, I don't expect it to not to change that much. If there are any changes that will affect previous versions I will describe what to change to upgrade.
I highly appreciate it when you are contributing to this crate. Also Since my native language is not English my grammar and sentence order will not be perfect. So improving this by correcting these mistakes will help both me and the reader of the docs.
This project is licensed under the MIT License - see the LICENSE.md file for details