package
Get tints and shades of a CSS color
npm install values.jsGitHub-flavored package documentation.
Across all versions.
Download trend unavailable.
Runtime metadata.
Tagged topics.
Latest published Mar 30, 2022
latest
beta
Get tints and shades of a CSS color
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.
NPM
npm install values.js --saveOr as a <script> tag from a CDN as Values:
Unpkg CDN
<script src="https://unpkg.com/values.js"></script>jsDelivr CDN
<script src="https://cdn.jsdelivr.net/npm/values.js"></script>import Values from 'values.js'
const color = new Values('hsl(204deg 100% 50% / 1)'), { log } = console
log(color.tint(25))
//> { rgb: [64, 179, 255], alpha: 1, type: "tint", weight: 25, ...methods }
log(color.shade(12))
//> { rgb: [0, 135, 224], alpha: 1, type: "shade", weight: 12, ...methods }
log(color.tints(8))
//> (12) [Values...]
log(color.shades(23))
//> (4) [Values...]
log(color.all(20))
//> (11) [Values...]
// instance example for 'red'
Values {
alpha: 1
rgb: (3) [255, 0, 0]
type: "base"
weight: 0
get hex: ƒ(...)
setColor: ƒ setColor(color)
tint: ƒ tint(weight=50)
tints: ƒ tints(weight=10)
shade: ƒ shade(weight=50)
shades: ƒ shades(weight=10)
all: ƒ all(weight=10)
hexString: ƒ hexString()
rgbString: ƒ rgbString()
getBrightness: ƒ getBrightness()
}See tests for more cases.
Throws if the color is not accepted.
@param {string} color — a valid CSS color stringSets a new base color, returns null if color has not been accepted.
@param {string} color - a valid CSS color string@return {Values|null}Lightens the base color by mixing it with white as specified by weight.
@param {number} [weight=50]@return {Values}Darkens the base color by mixing it with black as specified by weight.
@param {number} [weight=50]@return {Values}Generates the tints of the base color as specified by weight.
@param {number} [weight=10]@return {Array<Values>}Generates the shades of the base color as specified by weight.
@param {number} [weight=10]@return {Array<Values>}Generates the tints and shades of the base color as specified by weight.
@param {number} [weight=10]@return {Array<Values>}Returns the color in hexadecimal RGB notation.
@returns {string} @example #000000 or #00000080Returns the color in rgb() functional notation.
@returns {string} @example rgb(0, 0, 0) or rgba(0, 0, 0, 0.5)Calculates the brightness of the color.
@return {number} — the base-color brightness.npm install # install dev-dependencies
npm test # run the tests
npm run dev # watch for changes and run testsMIT © Noel Delgado
Estimated unpacked size across 6 packages.
76.9 kB
Includes dependencies.
3 direct · 1 outdated