Gradient color
Gradient color generator
Attention: This doc is for v2.0
, v1.x
usage is at the end of the doc, and it's deprecated
Installation
npm install gradient-color -S
Usage
const gradient = require('gradient-color')
const colors = gradient([
'#E5404C',
'#FD743C',
'#FD9C3C'
], 20)
console.log(colors)
API
gradient(colorArray, n)
where
-
colorArray is either
- An array of color strings. This way, each gradient's step is the same
['#fff', '#ddd', '#eee']
['rgb(23, 23, 23)', 'rgb(33, 33, 33)']
- An array of color object. You can specify each gradient's step value by
frac
field.
[
{
color: '#fff',
frac: 0.4
},
{
color: '#eee',
frac: 0.4
},
{
color: '#aaa',
frac: 0.2
},
{
color: '#fefefe'
}
]
If you are using this method, there're several things you should remember:
- The last color should not have a
frac
field, so it can be either an Object
with only color
field or a String
value - The sum of all the
frac
s should equal to 1
-
n is the number of color that will be generated. It should be greater than the length of your colorArray
, i.e. n > colorArray.length
Upcoming features
Nasty old v1.x usage (deprecated)
var getGradient = require('gradient-color').getGradient
var number = 30
var startColor = "#7e93f5"
var endColor = "#f32b65"
var colors = getGradient(number, startColor, endColor)