# @microsoft/fast-colors

> A color utility for generating a range of colors from a single color

Latest version **5.3.1** (published 2022-06-13) · MIT license · 0 weekly downloads

## Install

```sh
npm install @microsoft/fast-colors
pnpm add @microsoft/fast-colors
yarn add @microsoft/fast-colors
bun add @microsoft/fast-colors
```

## Health

**Score 45/100 (D)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high maintenance score; high quality score.

Warnings: low downloads.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 5.3.1 |
| Published | 2022-06-13 |
| First published | 2018-05-04 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 649.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 9670 |
| Author | Microsoft |
| Maintainers | microsoft1es, fastsvc, fluentweb, nirice, janechu, chrisdholt, awentzel |

## Links

- npm: https://www.npmjs.com/package/@microsoft/fast-colors
- Repository: https://github.com/Microsoft/fast
- Homepage: https://www.fast.design/
- Issues: https://github.com/Microsoft/fast/issues/new/choose
- npm.io page: https://npm.io/package/@microsoft/fast-colors

## Recent versions

- 5.3.1 (latest) — 2022-06-13
- 5.3.0 — 2022-04-27
- 5.2.0 — 2022-04-03
- 5.1.5 — 2022-02-09
- 5.1.4 — 2021-10-31
- 5.1.3 — 2021-04-06
- 5.1.2 — 2021-02-08
- 5.1.1 — 2021-02-08
- 5.1.0 — 2020-07-14
- 5.0.12 — 2020-07-02
- 5.0.11 — 2020-06-26
- 5.0.10 — 2020-06-09
- 5.0.9 — 2020-05-18
- 5.0.8 — 2020-04-29
- 5.0.7 — 2020-04-27
- … 38 more at https://npm.io/package/@microsoft/fast-colors/versions

## README

# FAST Colors

`@microsoft/fast-colors` includes a number of color classes and utilities designed to make parsing and manipulating colors easy, fast, and light-weight.

## Color classes

There are a number of color classes exported for common color formats. These include:

- `ColorHSL`
- `ColorHSV`
- `ColorLAB`
- `ColorLCH`
- `ColorRGBA64` (note each channel is a number from 0-1)
- `ColorXYZ`

```ts
const myColor: new ColorRGBA64(0, 0, 0, 1);

myColor.toStringHexRGB() // "#000000"
```

## Color parsers

A number of color parsers are also available to parse a variety of different color formats.

- `parseColorHexRGB(raw: string): ColorRGBA64 | null` parses `#RGB` or `#RRGGBB` color strings
- `parseColorHexARGB(raw: string): ColorRGBA64 | null` parses `#ARGB` or `#AARRGGBB` color strings
- `parseColorHexRGBA(raw: string): ColorRGBA64 | null` parses `#RGBA` or `#RRGGBBAA` color strings
- `parseColorWebRGB(raw: string): ColorRGBA64 | null` parses `#rgb(R, G, B)` color strings
- `parseColorWebRGBA(raw: string): ColorRGBA64 | null` parses `#rgb(R, G, B, A)` color strings
- `parseColorNamned(raw: string): ColorRGBA64 | null` parses [named color strings](https://www.w3schools.com/colors/colors_names.asp)

## Color Palette

A utility for creating a palette of colors from a source color and configuration options:

- `baseColor?: ColorRGBA64`
- `steps?: number`
- `interpolationMode?: ColorInterpolationSpace`
- `scaleColorLight?: ColorRGBA64`
- `scaleColorDark?: ColorRGBA64`
- `clipLight?: number`
- `clipDark?: number`
- `saturationAdjustmentCutoff?: number`
- `saturationLight?: number`
- `saturationDark?: number`
- `overlayLight?: number`
- `overlayDark?: number`
- `multiplyLight?: number`
- `multiplyDark?: number`

Example:

```ts
const palette: ColorPalette = new ColorPalette({
    baseColor: new ColorRGBA64(.4, .4, .7, 1),
    steps: 99,
    interpolationMode: ColorInterpolationSpace.RGB
})
```

## Color converters

A number of color converters are available to convert one color format to the other. Each color accepts a color class of the source type and returns a color class of the converted type:

- `hslToRGB`
- `rgbToHSL`
- `rgbToHSV`
- `hsvToRGB`
- `lchToLAB`
- `labToLCH`
- `labToXYZ`
- `xyzToLAB`
- `rgbToXYZ`
- `xyzToRGB`
- `rgbToLAB`
- `labToRGB`
- `rgbToLCH`
- `lchToRGB`

```ts
const rgb: ColorRGBA64 = new ColorRGBA64(.5, .5, .5, 1);
const hsl: ColorHSL = rgbToHSL(rgb);
```

---
_Source: https://npm.io/package/@microsoft/fast-colors · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._