random_color 0.8.0

Rust crate for generating random attractive colors
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135

# random_color

[![crate badge](https://img.shields.io/crates/v/random_color.svg)](https://crates.io/crates/random_color)

Rust crate for generating random attractive colors. Check it out on [crates.io](https://crates.io/crates/random_color).

Inspired by [RandomColor](https://github.com/davidmerfield/randomColor) by [davidmerfield](https://github.com/davidmerfield).

## Example projects

Amazing rust projects using `random_color`:

> [fake-rs](https://github.com/cksac/fake-rs) —
> a library for generating fake data in Rust

> [news-flash](https://github.com/patchedsoul/news-flash) —
> a modern feed reader designed for the GNOME desktop

> [cargo-trend](https://github.com/dalance/cargo-trend) —
> cargo subcommand to generate trend graph of dependent crates

> [light_phylogeny](https://github.com/simonpenel/light_phylogeny) —
> rust library dedicated to phylogeny

> [Voronoi](https://github.com/HactarCE/Voronoi) —
> simple program that draws Voronoi cells for a set of points

> [conways-game-of-life](https://github.com/eval-exec/conways-game-of-life) —
> conways' game of life in rust and with shiny colors

> [graph-sketchpad](https://github.com/dcheatha/graph-sketchpad) —
> program which allows one to visually create nodes and edges, simply using sdl2

> [CDCS](https://github.com/salmmanfred/CDCS) —
> helper program for creating Symphony of Empires mods



## Using the library

Check the online [documentation](https://docs.rs/random_color/latest/random_color/).

```rust
use random_color::color_dictionary::{ColorDictionary, ColorInformation};
use random_color::{Color, Luminosity, RandomColor};

let color = RandomColor::new()
  .hue(Color::Blue) // Optional
  .luminosity(Luminosity::Light) // Optional
  .seed(42) // Optional
  .alpha(1.0) // Optional
  .dictionary(ColorDictionary::new()) //optional
  .to_hsl_string(); // 

// color => "hsl(179, 99%, 10%)"
```

### Hue values

+ `Color::Monochrome`
+ `Color::Red`
+ `Color::Orange`
+ `Color::Yellow`
+ `Color::Green`
+ `Color::Blue`
+ `Color::Purple`
+ `Color::Pink`

### Luminosity values

+ `Luminosity::Random`
+ `Luminosity::Bright`
+ `Luminosity::Light`
+ `Luminosity::Dark`

### Alpha values

+ You can specify a value between 0 and 1 with `.alpha()`
+ You can specify a random value with `.random_alpha()`
  
### Outputs

```rust
  // As HSV Array
  let color = RandomColor::new().to_hsv_array(); // color => [179, 20, 100]

  // As RGB String
  let color = RandomColor::new().to_rgb_string(); // color => "rgb(204, 255, 254)"

  // As RGBA String
  let color = RandomColor::new().to_rgba_string(); // color => "rgba(204, 255, 254, 1)"

  // As RGB Array
  let color = RandomColor::new().to_rgb_array(); // color => [204, 255, 254]

  // As HSL String
  let color = RandomColor::new().to_hsl_string(); // color => "hsl(179, 99%, 10%)"

  // As HSLA String
  let color = RandomColor::new().to_hsla_string(); // color => "hsl(179, 99%, 10%, 1)"

  // As HSL Array
  let color = RandomColor::new().to_hsl_array(); // color => [179, 99, 10]
  
  // As Hex String
  let color = RandomColor::new().to_hex(); // color => "#b31464"
```

## Roadmap

+ Iteartor

## License

The MIT License (MIT)

Copyright (c) 2017 [Lucas Maximiliano Marino](https://lucasmarino.me)

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.