Crossterm Style | cross-platform styling.
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:
When you want to use other modules as well you might want to use crossterm with feature flags.
Table of contents:
Getting Started
This documentation is only for crossterm_style
version 0.3
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.3"
And import the crossterm_style
modules you want to use.
extern crate crossterm_style;
pub use ;
Useful Links
Features
These are the features of this crate:
- Cross-platform
- Multithreaded (send, sync)
- Detailed Documentation
- Few Dependencies
- Styled output
- Foreground Color (16 base colors)
- Background Color (16 base colors)
- 256 (ANSI) Color Support (Windows 10 and UNIX Only)
- RGB Color Support (Windows 10 and UNIX only)
- Text Attributes: bold, italic, underscore and crossed word and more (Windows 10 and UNIX only)
Examples
The examples folder has more complete and verbose examples.
style font with attributes
use ;
// pass any `Attribute` value to the formatting braces.
println!;
// you could also call different attribute methods on a `&str` and keep on chaining if needed.
let styled_text = "Bold Underlined".bold.underlined;
println!;
// old-way but still usable
let styled_text = style.bold.underlined;
style font with colors
use ;
println!;
println!;
// you can also call different coloring methods on a `&str`.
let styled_text = "Bold Underlined".red.on_blue;
println!;
// old-way but still usable
let styled_text = style.with.on;
style font with RGB and ANSI Value
// custom rgb value (Windows 10 and UNIX systems)
println!;
// custom ansi color value (Windows 10 and UNIX systems)
println!;
Tested terminals
- Windows Powershell
- Windows 10 (pro)
- Windows CMD
- Windows 10 (pro)
- Windows 8.1 (N)
- Ubuntu Desktop Terminal
- Ubuntu 17.10
- (Arch, Manjaro) KDE Konsole
- Linux Mint
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.
Authors
- Timon Post - Project Owner & creator
License
This project is licensed under the MIT License - see the LICENSE.md file for details