repository·master·Indexed 27 days ago
https://github.com/davidmerfield/randomcolorA tiny script for generating attractive random colors in both browser and Node.js environments. Version 0.6.2 supports customization of hue (via names, numbers, or hex), luminosity (bright, light, dark), and output formats including hex, rgb, rgba, hsl, hsla, and arrays. It allows generating multiple colors using the count option and repeatable results via a seed.
Import the library and call randomColor() to generate a color string. By default, it returns a hex code for an attractive color.
In Node.js:
var randomColor = require('randomcolor');
var color = randomColor();In the Browser:
var color = randomColor();var randomColor = require('randomcolor'); // import the script
var color = randomColor(); // a hex code for an attractive colorDownload the latest minified version of randomColor from a CDN (like cdnjs) and include it in your HTML page.
Install the package via npm:
npm install randomcolorseed in the options. The seed can be an integer or a string. If a string is provided, it is converted to an integer internally.The hue option allows you to restrict the color range. You can provide:
'red', 'orange', 'yellow', 'green', 'blue', 'purple', 'pink', and 'monochrome'.'#00ff00').When using count with a specific hue, the library attempts to pick distinct colors within that hue range to avoid duplicates.
Use the options object to generate arrays of colors or specific color models like RGB or HSL.
// Returns an array of ten green colors
randomColor({
count: 10,
hue: 'green'
});
// Returns a bright color in RGB
randomColor({
luminosity: 'bright',
format: 'rgb'
});
// Returns a dark RGB color with specified alpha
randomColor({
luminosity: 'dark',
format: 'rgba',
alpha: 0.5
});// Returns an array of ten green colors
randomColor({
count: 10,
hue: 'green'
});
// Returns a bright color in RGB
randomColor({
luminosity: 'bright',
format: 'rgb' // e.g. 'rgb(225,200,20)'
});
// Returns a dark RGB color with specified alpha
randomColor({
luminosity: 'dark',
format: 'rgba',
alpha: 0.5 // e.g. 'rgba(9, 1, 107, 0.5)',
});Pass an options object to randomColor() to customize the output.
| Option | Type | Description |
|---|---|---|
hue | string | Controls hue. Supported names: red, orange, yellow, green, blue, purple, pink, monochrome. You can also pass a hex string (e.g., #00FFFF) to extract its hue. |
luminosity | string | Controls brightness. Values: bright, light, dark. |
count | integer | The number of colors to generate. |
seed | integer or string | Provides a seed so the function returns the same color every time. |
format | string | The output format. Values: rgb, rgba, rgbArray, hsl, hsla, hslArray, hex (default). |
alpha | number | A decimal between 0 and 1. Only used with rgba or hsla formats. Defaults to a random value. |
randomColor(options) function is the primary entry point for generating random colors. It can return a single color string or an array of color strings based on the options provided. It supports various color formats, luminosity settings, and seeding for repeatable results.The format option determines the string representation of the generated color. Supported formats include:
| Format | Description |
|---|---|
hsvArray | Returns [H, S, B] array |
hslArray | Returns [H, S, L] array |
hsl | Returns hsl(H, S%, L%) string |
hsla | Returns hsla(H, S%, L%, A) string (uses alpha option or random) |
rgbArray | Returns [R, G, B] array |
rgb | Returns rgb(R, G, B) string |
rgba | Returns rgba(R, G, B, A) string (uses alpha option or random) |
| (default) | Returns #RRGGBB hex string |