Skip to content

Latest commit

 

History

History
80 lines (49 loc) · 3.1 KB

README.md

File metadata and controls

80 lines (49 loc) · 3.1 KB

This package is deprecated. Since HSL is widely supported now, please consider using golden-number which is more lightweight and versatile.

golden-colors

Random color generation for JavaScript and Node.js based on How To Generate Random Colors Programmatically by Martin Ankerl. Colors generated using Golden ratio conjugate can be used as background colors for easily readable labels, buttons, etc.

Installation

Download the latest version from Github or use npm or Bower:

npm install golden-colors

Then just include dist/golden-colors.js or dist/golden-colors.min.js in your html. AMD-version of the library that also supports Browserify also available as dist/golden-colors-amd.js/dist/golden-colors-amd.min.js.

and require it in your code:

var goldenColors = require('golden-colors');

API

goldenColors

There are three functions for color generation. All three functions return an instance of WebColor.

getHsvGolden(s, v)

Random color in HSV system with random value for hue set at startup and distributed using Golden ratio conjugate with specified saturation and value.

getHsvSimple(s, v)

Random color in HSV system with random values for hue with specified saturation and value.

getNaive()

Just random values for R, G, B.

WebColor

An object with R, G, and B values that can be converted into CSS2-compatible string.

toRgb()

Returns an Array of [r, g, b] with decimal values.

toRgbString()

Returns a String of rgb(r, g, b) with decimal values.

toHexString()

toString()

toJSON()

Returns a String of #rgb with hexadecimal values.

License

The MIT License (MIT)

Copyright (c) 2014-2015 Alexey Komarov [email protected]

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.