temp-color/README.md

Convert any quantity to RGB color

# Temperature To Color

![version](https://img.shields.io/npm/v/temp-color)
![size](https://img.shields.io/bundlephobia/minzip/temp-color)
![downloads](https://img.shields.io/npm/dw/temp-color)
![build](https://img.shields.io/travis/com/szymslo/temp-color)
[![codecov](https://codecov.io/gh/szymslo/temp-color/branch/main/graph/badge.svg?token=8OAZESM0LG)](https://codecov.io/gh/szymslo/temp-color)
![license](https://img.shields.io/npm/l/temp-color)

### Convert temperature, or any other quantity, to a RGB color

# ![rgbspectrum](https://user-images.githubusercontent.com/52113159/110655867-b926da80-81bf-11eb-8f0f-44fe82f4129f.jpg)

## Installation

`npm i temp-color`

`yarn add temp-color`

## Usage

```js
import { tempToColor } from 'temp-color';

const { r, g, b } = tempToColor(10, -30, 30);

const { r, g, b } = tempToColor(10, 0, 100, 'half');

const { r, g, b } = tempToColor(10, -30, 30, 'extended');
```
## Parameters

```
tempToColor = (t: number, min: number, max: number, mode?: string) : {r: number, g: number, b: number}
```

#### Function takes four parameters:
* _t_ - value that will be scaled into RGB
* _min_ - lowest possible value (scale begins there)
* _max_ - highest possible value (scale ends there)
* _mode_ - OPTIONAL

### Mode
* **default** - scaling from blue to red -> no need to provide any additional parameters
* **extended** - scaling from violet-blue to violet-red -> add _'extended'_ parameter at the end
* **half** - scaling from green to red (from good to bad); no blue colors -> add _'half'_ parameter at the end


#### Function returns an object with calculated RGB values

## Examples

#### Change background dynamically based on a value set by a range slider

```js
import {tempToColor} from 'temp-color';

let isHeld = false;
const box = document.querySelector("#box");
const slider = document.querySelector("#slider");

slider.addEventListener('mousedown', () => {
    isHeld = true;
});

slider.addEventListener('mouseup', () => {
    isHeld = false;
});

slider.addEventListener('mousemove', () => {
    if (isHeld) {
        const {r,g,b} = tempToColor(parseFloat(slider.value), parseInt(slider.min), parseInt(slider.max));
        box.style.background = `rgb(${r},${g},${b})`;
    }
});

```