values.js

Values.js

The lightness or darkness of a color is called its value. Tints are light values that are made by mixing a color with white, which increases lightness. Shades are dark values that are made by mixing a color with black, which reduces lightness.

http://noeldelgado.github.io/Values.js/

Installation

Node

npm install values.js

Bower

bower install values.js

Usage

// node
var Values = require('values.js');

// browser
<script src="path-to-values/index.js"></script>

Example

var color = new Values('#0099ff');

console.log(color.hex)              // => "0099ff"
console.log(color.rgb)              // => {r:0, g:153, b:255}
console.log(color.hsl) 	            // => {h:204, s: 100, l: 50}

console.log(color.hexString())      // => "#0099ff"
console.log(color.rgbString()) 	    // => "rgb(0, 153, 255)"
console.log(color.hslString())      // => "hsl(204, 100%, 50%)"

console.log(color.getBrightness())  // => 53

color.tints().forEach(function(tint) {
	console.log(tint);     // => [Value instance]
});

color.shades().forEach(function(shade) {
	console.log(shade);    // => [Value instance]
});

// tints, original color and shades
color.all().forEach(function(color) {
    console.log(color);   // => [Value instance]
});

Methods

setColor

/**
Sets the base color for which all operations are based. Updates the instance's properties.
@method setColor <public> [Function]
@param color <required> [String] A valid color format (#000, rgb(0,0,0), hsl(0,0%,0%))
@return Values instance || Error [Object]
*/
color.setColor('ff0');
color.setColor('rgb(255,255,0)');
color.setColor('hsl(60,100%,50%)');

tint

/**
Lightens the instance by mixing it with white as specified by @percentage.
@method tint <public> [Function]
@param percentage <optional> [Number] {50}
@return new Values instance [Object]
*/

color.tint();
color.tint(10);
color.tint(24);

shade

/**
Darkens the instance color by mixing it with black as specified by @percentage.
@method shade <public> [Function]
@param percentage <optional> [Number] {50}
@return new Values instance [Object]
*/

color.shade();
color.shade(9);
color.shade(31);

tints

/**
Generates the tints of the instance color as specified by @percentage.
@method tints <public> [Function]
@param percentage <optional> [Number] {10}
@return Array of Values instances [Array]
*/

color.tints(20).forEach(function(tint) {
    console.log(tint)
})

shades

/**
Generates the shades of the instance color as specified by @percentage.
@method shades <public> [Function]
@param percentage <optional> [Number] {10}
@return Array of Values instances [Array]
*/

color.shades(20).forEach(function(shade) {
    console.log(shade)
})

all

/**
Generates the tints and shades of the instance color as specified by @percentage.
@method all <public> [Function]
@param percentage <optional> [Number] {10}
@return Array of Values instances [Array]
*/

color.all().forEach(function(color) {
    console.log(color)
})

Values.Utils

isHex(color)

Values.Utils.isHEX('09c')     => true
Values.Utils.isHEX('#09c')    => true
Values.Utils.isHEX('#0099cc') => true
Values.Utils.isHEX('09cc')    => false

isRGB(color)

Values.Utils.isRGB('rgb(0,0,0)')    => true
Values.Utils.isRGB('rgba(0,0,0,.0)') => true
Values.Utils.isRGB('0,0,0')         => false

isHSL(color)

Values.Utils.isHSL('hsl(198,58%,1%)')      => true
Values.Utils.isHSL('hsla(360,10%,10%, 1)') => true
Values.Utils.isHSl('hsl(361,10%,10%)')     => false

Dev

npm install     # install dev-dependencies
npm run dev     # watch for changes and run tests