1.0.6 • Published 4 years ago
polate-js v1.0.6
polate-js
Polate-js is a numerical and color interpolation utility for Javascript and Typescript.
Installation
Setup via NPM
npm install polate-js --saveSetup via Yarn
yarn add polate-jsUsage
Numerical interpolation
// import interpolate from 'polate-js';
import interpolate from "polate-js";
var valueToSolveFor = 1;
var interpolatedValue = interpolate(valueToSolveFor, {
inputRange: [0, 2, 3],
outputRange: [5, 7, 9],
extrapolate: "clamp"
});
console.log(interpolatedValue); // ==> 6Color interpolation
import interpolate from "polate-js";
var valueToSolveFor = 1;
var interpolatedValue = interpolate(valueToSolveFor, {
inputRange: [0, 1],
outputRange: ["#ff0000", "#ffffff"]
});
console.log(interpolatedValue); // ==> #ff8080InterpolationConfig
| Prop | Description | Default |
|---|---|---|
inputRange | An array of any length of numbers to be used as the input range. | |
outputRange | A range of values to be mapped to the specified input range. It has to be the same length as the inputRange array. Provide an array of numbers to use a numerical interpolation technique, or an array of valid HEX or RGB colors to interpolate between colors. | |
extrapolate | What technique to use when the value to solve for is not within the input range. Can be either clamp or extend. | extend |
License
MIT © Oluwaseun Adedire