Skip to content

Latest commit

 

History

History
91 lines (65 loc) · 3.67 KB

README.md

File metadata and controls

91 lines (65 loc) · 3.67 KB
Raw

Random Color

A tiny script for generating attractive random colors. See the results on the demo.

Demo

randomColor is available minified on cdnjs. It is also distributed on npm and bower.

npm install randomcolor

randomColor has been ported to C#, Go, PHP, Python, Swift, Objective-C, Java and R.

Options

You can pass an options object to influence the type of color it produces. The options object accepts the following properties:

Hue – Controls the hue of the generated color. You can pass a string representing a color name: red, orange, yellow, green, blue, purple, pink and monochrome are currently supported.

Luminosity – Controls the luminosity of the generated color. You can specify a string containing bright, light or dark.

Count – An integer which specifies the number of colors to generate.

Seed - An integer or string which when passed will cause randomColor to return the same color each time.

Format – A string which specifies the format of the generated color. Possible values are rgb, rgbArray, hsl, hslArray and hex (default).

Examples

// Returns a hex code for an attractive color
randomColor(); 

// Returns an array of ten green colors
randomColor({
   count: 10,
   hue: 'green'
});

// Returns a hex code for a light blue
randomColor({
   luminosity: 'light',
   hue: 'blue'
});

// Returns a hex code for a 'truly random' color
randomColor({
   luminosity: 'random',
   hue: 'random'
});

// Returns a bright color in RGB
randomColor({
   luminosity: 'bright',
   format: 'rgb' // e.g. 'rgb(225,200,20)'
});

// Returns a dark RGB color with random alpha
randomColor({
   luminosity: 'dark',
   format: 'rgba' // e.g. 'rgba(9, 1, 107, 0.6482447960879654)'
});

// Returns a light HSL color with random alpha
randomColor({
   luminosity: 'light',
   format: 'hsla' // e.g. 'hsla(27, 88.99%, 81.83%, 0.6450211517512798)'
});

License

This project is dedicated to the public domain.

To do

More generally, it might be a good idea to consider using other color models.

  1. When returning an array of multiple colors, try to make each color as distinct as possible. Make sure each color is distinct to its neighbours.
  2. Improve attractive dark color generation, currently they're a touch murky.
  3. Improve the color dictionary
  • definition of hue values and attractive luminosity bounds
  • think about how to store hue aliases (e.g. fuschia) or subranges (e.g teal)
  • think about making a little point and click tool for defining your own luminosity bounds and customizing the color dictionary
  1. Think about how to return seeds.
  2. Think about adding feature to return complementary & contrasting colors, as well as color triads, tetrads etc. Other libraries might already do this better though.
  3. Think about adding a scheme options which would return a dominant color, as well as secondary, tertiary color and primary and secondary text colors. This might be a bad idea.
  4. Add a feature to return random colors close to a provided hex