Package Exports
- javascript-color-gradient
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (javascript-color-gradient) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
javascript-color-gradient
Lightweight JavaScript library, used to generate an array of color gradients by providing start and finish colors, as well as the required number of midpoints.
Installation
npm install javascript-color-gradientUsage
import Gradient from "javascript-color-gradient";
const colorGradient = new Gradient();
const color1 = "#3F2CAF";
const color2 = "#8BC2E3";
colorGradient.setGradient(color1, color2);Methods
setGradient(color1, color2) - sets two or more hex color values. Should always be defined.
setMidpoint(n) - sets the number range from 0 to n. By default n is 10.
getArray() - returns an array of hex colors. Requires no parameters.
getColor(n) - returns certain hex color, where n is a requested number of midpoint colors.
console.log(colorGradient.getArray()) // outputs ["#4e4ab9", "#5d68c4", "#6d86ce", "#7ca4d9", "#8bc2e3"]
console.log(colorGradient.getColor(3)) // outputs #6d86ceExamples
Implementing javascript-color-gradient library into React.js application, using two gradient colors and 4 midpoints.
Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Please make sure to update tests as appropriate.
License
javascript-color-gradient is MIT licensed.