README.md
1<h1 align="center">
2 <a>Colorful</a>
3 <br>
4 <br>
5</h1>
6
7[![Build Status](https://travis-ci.org/rocketsman/colorful.svg?branch=master)](https://travis-ci.org/rocketsman/colorful) [![Coverage Status](https://coveralls.io/repos/github/rocketsman/colorful/badge.svg?branch=master)](https://coveralls.io/github/rocketsman/colorful?branch=master) [![Codacy Badge](https://api.codacy.com/project/badge/Grade/37a45510f41445eea0168f0f07e8f7cb)](https://app.codacy.com/app/rocketsman/colorful_2?utm_source=github.com&utm_medium=referral&utm_content=rocketsman/colorful&utm_campaign=Badge_Grade_Dashboard)
8
9## Usage
10
11### Basic Usage
12
13```Rust
14extern crate colorful;
15
16use colorful::Color;
17use colorful::Colorful;
18//use colorful::HSL;
19//use colorful::RGB;
20
21fn main() {
22 let s = "Hello world";
23 println!("{}", s.color(Color::Blue).bg_color(Color::Yellow).bold());
24 // println!("{}", s.color(HSL::new(1.0, 1.0, 0.5)).bold());
25 // println!("{}", s.color(RGB::new(255, 0, 0)).bold());
26 println!("{}", s.blue().bg_yellow());
27}
28```
29
30### Gradient
31
32```Rust
33extern crate colorful;
34
35use colorful::Color;
36use colorful::Colorful;
37
38fn main() {
39 println!("{}", "This code is editable and runnable!".gradient(Color::Red));
40 println!("{}", "¡Este código es editable y ejecutable!".gradient(Color::Green));
41 println!("{}", "Ce code est modifiable et exécutable !".gradient(Color::Yellow));
42 println!("{}", "Questo codice è modificabile ed eseguibile!".gradient(Color::Blue));
43 println!("{}", "このコードは編集して実行出来ます!".gradient(Color::Magenta));
44 println!("{}", "여기에서 코드를 수정하고 실행할 수 있습니다!".gradient(Color::Cyan));
45 println!("{}", "Ten kod można edytować oraz uruchomić!".gradient(Color::LightGray));
46 println!("{}", "Este código é editável e executável!".gradient(Color::DarkGray));
47 println!("{}", "Этот код можно отредактировать и запустить!".gradient(Color::LightRed));
48 println!("{}", "Bạn có thể edit và run code trực tiếp!".gradient(Color::LightGreen));
49 println!("{}", "这段代码是可以编辑并且能够运行的!".gradient(Color::LightYellow));
50 println!("{}", "Dieser Code kann bearbeitet und ausgeführt werden!".gradient(Color::LightBlue));
51 println!("{}", "Den här koden kan redigeras och köras!".gradient(Color::LightMagenta));
52 println!("{}", "Tento kód můžete upravit a spustit".gradient(Color::LightCyan));
53 println!("{}", "این کد قابلیت ویرایش و اجرا دارد!".gradient(Color::White));
54 println!("{}", "โค้ดนี้สามารถแก้ไขได้และรันได้".gradient(Color::Grey0));
55}
56
57```
58<div align="center">
59 <img src="images/1.png" width="600px"</img>
60</div>
61
62### Gradient with style
63
64```Rust
65extern crate colorful;
66
67use colorful::Colorful;
68
69fn main() {
70 println!("{}", "言葉にできず 凍えたままで 人前ではやさしく生きていた しわよせで こんなふうに雑に 雨の夜にきみを 抱きしめてた".gradient_with_color(HSL::new(0.0, 1.0, 0.5), HSL::new(0.833, 1.0, 0.5)).underlined());
71}
72```
73
74<div align="center">
75 <img src="images/2.png" width="700px"</img>
76</div>
77
78### Bar chart
79
80```Rust
81extern crate colorful;
82
83use colorful::Colorful;
84use colorful::HSL;
85
86fn main() {
87 let s = "█";
88 println!("{}\n", "Most Loved, Dreaded, and Wanted Languages".red());
89 let values = vec![78.9, 75.1, 68.0, 67.0, 65.6, 65.1, 61.9, 60.4];
90 let languages = vec!["Rust", "Kotlin", "Python", "TypeScript", "Go", "Swift", "JavaScript", "C#"];
91 let c = languages.iter().max_by_key(|x| x.len()).unwrap();
92
93 for (i, value) in values.iter().enumerate() {
94 let h = (*value as f32 * 15.0 % 360.0) / 360.0;
95 let length = (value - 30.0) as usize;
96 println!("{:<width$} | {} {}%\n", languages.get(i).unwrap(), s.repeat(length).gradient(HSL::new(h, 1.0, 0.5)), value, width = c.len());
97 }
98}
99```
100Output
101
102<div align="center">
103 <img src="images/3.png" width="500px"</img>
104</div>
105
106### Animation
107
108#### Rainbow
109
110```Rust
111extern crate colorful;
112
113use colorful::Colorful;
114
115fn main() {
116 let text = format!("{:^50}\n{}\r\n{}", "岳飞 小重山", "昨夜寒蛩不住鸣 惊回千里梦 已三更 起身独自绕阶行 人悄悄 帘外月胧明",
117 "白首为功名 旧山松竹老 阻归程 欲将心事付瑶琴 知音少 弦断有谁听");
118 text.rainbow();
119}
120```
121Output
122
123<div align="center">
124 <img src="images/11.gif"</img>
125</div>
126
127#### Neon
128
129```Rust
130extern crate colorful;
131
132use colorful::Colorful;
133
134fn main() {
135 let text = format!("{:^28}\n{}", "WARNING", "BIG BROTHER IS WATCHING YOU!!!");
136 text.neon(RGB::new(226, 14, 14), RGB::new(158, 158, 158));
137 // or you can use text.warn();
138}
139
140```
141Output
142
143<div align="center">
144 <img src="images/22.gif"</img>
145</div>
146
147
148## Terminals compatibility
149
150<table style="font-size: 60%; padding: 1px;">
151<thead>
152<tr>
153<th rowspan=2>Terminal</th>
154<th colspan=6 align=center>Formatting</th>
155<th colspan=4 align=center>Color</th>
156</tr>
157<tr>
158<!-- Formatting ---------><th>Bold</th><th>Dim</th><th>Underlined</th><th>Blink</th><th>Invert</th><th>Hidden</th>
159<!--Color -------><th>8</th><th>16</th><th>88</th><th>256</th>
160</tr>
161<tbody>
162<tr align=center><td>aTerm </td><td> <img src="images/yes.png" alt=""/> </td><td><img src="images/no.png" alt=""/></td><td> <img src="images/yes.png" alt=""/> </td><td><img src="images/no.png" alt=""/></td><td> <img src="images/yes.png" alt=""/> </td><td><img src="images/no.png" alt=""/></td><td> <img src="images/yes.png" alt=""/> </td><td> ~ </td><td><img src="images/no.png" alt=""/></td><td><img src="images/no.png" alt=""/></td></tr>
163<tr align=center><td>Eterm </td><td> ~ </td><td><img src="images/no.png" alt=""/></td><td> <img src="images/yes.png" alt=""/> </td><td><img src="images/no.png" alt=""/></td><td> <img src="images/yes.png" alt=""/> </td><td><img src="images/no.png" alt=""/></td><td> <img src="images/yes.png" alt=""/> </td><td> ~ </td><td><img src="images/no.png" alt=""/></td><td> <img src="images/yes.png" alt=""/></td></tr>
164<tr align=center><td>GNOME Terminal </td><td> <img src="images/yes.png" alt=""/> </td><td> <img src="images/yes.png" alt=""/> </td><td> <img src="images/yes.png" alt=""/> </td><td> <img src="images/yes.png" alt=""/> </td><td> <img src="images/yes.png" alt=""/> </td><td> <img src="images/yes.png" alt=""/> </td><td> <img src="images/yes.png" alt=""/> </td><td> <img src="images/yes.png" alt=""/> </td><td><img src="images/no.png" alt=""/></td><td> <img src="images/yes.png" alt=""/></td></tr>
165<tr align=center><td>Guake </td><td> <img src="images/yes.png" alt=""/> </td><td> <img src="images/yes.png" alt=""/> </td><td> <img src="images/yes.png" alt=""/> </td><td> <img src="images/yes.png" alt=""/> </td><td> <img src="images/yes.png" alt=""/> </td><td> <img src="images/yes.png" alt=""/> </td><td> <img src="images/yes.png" alt=""/> </td><td> <img src="images/yes.png" alt=""/> </td><td><img src="images/no.png" alt=""/></td><td> <img src="images/yes.png" alt=""/></td></tr>
166<tr align=center><td>Konsole </td><td> <img src="images/yes.png" alt=""/> </td><td><img src="images/no.png" alt=""/></td><td> <img src="images/yes.png" alt=""/> </td><td> <img src="images/yes.png" alt=""/> </td><td> <img src="images/yes.png" alt=""/> </td><td><img src="images/no.png" alt=""/></td><td> <img src="images/yes.png" alt=""/> </td><td> <img src="images/yes.png" alt=""/> </td><td><img src="images/no.png" alt=""/></td><td> <img src="images/yes.png" alt=""/></td></tr>
167<tr align=center><td>Nautilus Terminal </td><td> <img src="images/yes.png" alt=""/> </td><td> <img src="images/yes.png" alt=""/> </td><td> <img src="images/yes.png" alt=""/> </td><td> <img src="images/yes.png" alt=""/> </td><td> <img src="images/yes.png" alt=""/> </td><td> <img src="images/yes.png" alt=""/> </td><td> <img src="images/yes.png" alt=""/> </td><td> <img src="images/yes.png" alt=""/> </td><td><img src="images/no.png" alt=""/></td><td> <img src="images/yes.png" alt=""/></td></tr>
168<tr align=center><td>rxvt </td><td> <img src="images/yes.png" alt=""/> </td><td><img src="images/no.png" alt=""/></td><td> <img src="images/yes.png" alt=""/> </td><td> ~ </td><td> <img src="images/yes.png" alt=""/> </td><td><img src="images/no.png" alt=""/></td><td> <img src="images/yes.png" alt=""/> </td><td> <img src="images/yes.png" alt=""/> </td><td> <img src="images/yes.png" alt=""/> </td><td><img src="images/no.png" alt=""/></td></tr>
169<tr align=center><td>Terminator </td><td> <img src="images/yes.png" alt=""/> </td><td> <img src="images/yes.png" alt=""/> </td><td> <img src="images/yes.png" alt=""/> </td><td><img src="images/no.png" alt=""/></td><td> <img src="images/yes.png" alt=""/> </td><td> <img src="images/yes.png" alt=""/> </td><td> <img src="images/yes.png" alt=""/> </td><td> <img src="images/yes.png" alt=""/> </td><td><img src="images/no.png" alt=""/></td><td> <img src="images/yes.png" alt=""/></td></tr>
170<tr align=center><td>Tilda </td><td> <img src="images/yes.png" alt=""/> </td><td><img src="images/no.png" alt=""/></td><td> <img src="images/yes.png" alt=""/> </td><td> <img src="images/yes.png" alt=""/> </td><td> <img src="images/yes.png" alt=""/> </td><td><img src="images/no.png" alt=""/></td><td> <img src="images/yes.png" alt=""/> </td><td> <img src="images/yes.png" alt=""/> </td><td><img src="images/no.png" alt=""/></td><td><img src="images/no.png" alt=""/></td></tr>
171<tr align=center><td>XFCE4 Terminal </td><td> <img src="images/yes.png" alt=""/> </td><td> <img src="images/yes.png" alt=""/> </td><td> <img src="images/yes.png" alt=""/> </td><td> <img src="images/yes.png" alt=""/> </td><td> <img src="images/yes.png" alt=""/> </td><td> <img src="images/yes.png" alt=""/> </td><td> <img src="images/yes.png" alt=""/> </td><td> <img src="images/yes.png" alt=""/> </td><td><img src="images/no.png" alt=""/></td><td> <img src="images/yes.png" alt=""/></td></tr>
172<tr align=center><td>XTerm </td><td> <img src="images/yes.png" alt=""/> </td><td><img src="images/no.png" alt=""/></td><td> <img src="images/yes.png" alt=""/> </td><td> <img src="images/yes.png" alt=""/> </td><td> <img src="images/yes.png" alt=""/> </td><td> <img src="images/yes.png" alt=""/> </td><td> <img src="images/yes.png" alt=""/> </td><td> <img src="images/yes.png" alt=""/> </td><td><img src="images/no.png" alt=""/></td><td> <img src="images/yes.png" alt=""/> </td></tr>
173<tr align=center><td>xvt </td><td> <img src="images/yes.png" alt=""/> </td><td><img src="images/no.png" alt=""/></td><td> <img src="images/yes.png" alt=""/> </td><td><img src="images/no.png" alt=""/></td><td> <img src="images/yes.png" alt=""/> </td><td><img src="images/no.png" alt=""/></td><td><img src="images/no.png" alt=""/></td><td><img src="images/no.png" alt=""/></td><td><img src="images/no.png" alt=""/></td><td><img src="images/no.png" alt=""/></td></tr>
174<tr align=center><td>Linux TTY </td><td> <img src="images/yes.png" alt=""/> </td><td><img src="images/no.png" alt=""/></td><td><img src="images/no.png" alt=""/></td><td><img src="images/no.png" alt=""/></td><td> <img src="images/yes.png" alt=""/> </td><td><img src="images/no.png" alt=""/></td><td> <img src="images/yes.png" alt=""/> </td><td> ~ </td><td><img src="images/no.png" alt=""/></td><td><img src="images/no.png" alt=""/></td></tr>
175<tr align=center><td>VTE Terminal </td><td> <img src="images/yes.png" alt=""/> </td><td> <img src="images/yes.png" alt=""/> </td><td> <img src="images/yes.png" alt=""/> </td><td> <img src="images/yes.png" alt=""/> </td><td> <img src="images/yes.png" alt=""/> </td><td> <img src="images/yes.png" alt=""/> </td><td> <img src="images/yes.png" alt=""/> </td><td> <img src="images/yes.png" alt=""/> </td><td><img src="images/no.png" alt=""/></td><td> <img src="images/yes.png" alt=""/></td></tr>
176</tbody>
177</thead>
178</table>
179
180~: Supported in a special way by the terminal.
181
182## Todo
183
184- [x] Basic 16 color
185- [ ] Extra 240 color
186- [x] HSL support
187- [x] RGB support
188- [x] Gradient mode
189- [x] Rainbow mode
190- [x] Animation mode
191- [ ] Document
192- [x] Terminals compatibility
193
194## License
195
196[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fda2018%2Fcolorful.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fda2018%2Fcolorful?ref=badge_large)
197