# @chayns/colors

> JavaScript utility functions for the calculation of colors for chayns

Latest version **2.0.2** (published 2026-01-02) · MIT license · 0 weekly downloads

## Install

```sh
npm install @chayns/colors
pnpm add @chayns/colors
yarn add @chayns/colors
bun add @chayns/colors
```

## Health

**Score 65/100 (B)** — status: stable.

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

Warnings: low downloads.

## Facts

| | |
|---|---|
| Version | 2.0.2 |
| Published | 2026-01-02 |
| First published | 2020-09-18 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 365.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 1 |
| Author | Jonas Gossens |
| Maintainers | tobit.software |
| Keywords | chayns, colors, tobit, tobit.labs, tobit.software |

## Links

- npm: https://www.npmjs.com/package/@chayns/colors
- Repository: https://github.com/TobitSoftware/chayns-colors
- Homepage: https://github.com/TobitSoftware/chayns-colors#readme
- Issues: https://github.com/TobitSoftware/chayns-colors/issues
- npm.io page: https://npm.io/package/@chayns/colors

## Alternatives

- [postcss-color-hex-alpha](https://npm.io/package/postcss-color-hex-alpha.md) — 6.4M weekly downloads
- [randomcolor](https://npm.io/package/randomcolor.md) — 348.0K weekly downloads
- [bows](https://npm.io/package/bows.md) — 1.3K weekly downloads
- [ep_prefer_color_scheme](https://npm.io/package/ep_prefer_color_scheme.md) — 260 weekly downloads
- [coc-yank](https://npm.io/package/coc-yank.md) — 61 weekly downloads

## Recent versions

- 2.0.2 (latest) — 2026-01-02
- 2.0.1 — 2025-12-12
- 2.0.0 — 2021-09-23
- 1.0.4 — 2021-06-08
- 1.0.3 — 2021-03-25
- 1.0.2 — 2021-03-17
- 1.0.1 — 2021-03-02
- 1.0.0 — 2020-09-18

## README

# @chayns/colors
JavaScript utility functions for the calculation of colors for chayns

## Usage

### Installation
This package can be installed from npm using ``npm install @chayns/colors``.

### Color Model Value Ranges

#### [RGB (Red - Green - Blue)](https://en.wikipedia.org/wiki/RGB_color_model)
HEX
- Three (four with transparency) components of each two hexadecimal characters, starting with a ``#``.
- Example: #00ff3d (chayns blue)

RGB255
- r, g, b: 0 - 255
- a (transparency, optional): 0 - 1

RGB1
- r, g, b: 0 - 1
- a (transparency, optional): 0 - 1

#### [HSL and HSV](https://en.wikipedia.org/wiki/HSL_and_HSV)
HSL (Hue - Saturation - Lightness)
- h: 0 - 360
- s, l: 0 - 1
- a (transparency, optional): 0 - 1

HSV (Hue - Saturation - Value)
- h: 0 - 360
- s, v: 0 - 1
- a (transparency, optional): 0 - 1

### Available Functions
This package provides general functions to convert colors from one color model into another as well as chayns-specific functions for generating chayns colors.
All functions allow the usage of colors with a transparency. You just have to add ``a`` to your color (fourth hexadecimal pair for HEX color).

You can import the functions like this: ``import { isHex } from @chayns/colors;``.

Color model conversion functions:
- rgb1ToRgb255(rgb1)
- rgb1ToHex(rgb1)
- rgb1ToHsl(rgb1)
- rgb1ToHsv(rgb1)
- rgb255ToRgb1(rgb255)
- rgb255ToHex(rgb255)
- rgb255ToHsl(rgb255)
- rgb255ToHsv(rgb255)
- hexToRgb1(hex)
- hexToRgb255(hex)
- hexToHsl(hex)
- hexToHsv(hex)
- hslToRgb1(hsl)
- hslToRgb255(hsl)
- hslToHex(hsl)
- hslToHsv(hsl)
- hsvToRgb1(hsv)
- hsvToRgb255(hsv)
- hsvToHex(hsv)
- hsvToHsl(hsv)

Functions for normalizing and generating color strings:
- normalizeHexString(hex)
- normalizeRgbString(rgbString)
- getRgb255String(rgb255)

Mixing functions:
- mixHsv(color1, color2, weight)
- mixHsl(color1, color2, weight)
- mixRgb(color1, color2, weight)
- mixHex(color1, color2, weight)

Lightening/darkening functions:
- lightenHslColor(color, percent)
- lightenHexColor(color, percent)
- lightenHsvColor(color, percent)
- lightenRgb255Color(color, percent)
- darkenHexColor(color, percent)
- darkenHslColor(color, percent)
- darkenHsvColor(color, percent)
- darkenRgb255Color(color, percent)

Type check functions:
- isHex(value)
- isRgbString(value)
- isRgb255(value)
- isRgb1(value)
- isHsl(value)
- isHsv(value)

Chayns-specific functions
- getColorFromPalette(colorId, options)
    - options is an object of color, colorMode and secondaryColor
- getAvailableColorList()

## Releases
[Releasenotes](https://github.com/TobitSoftware/chayns-colors/releases) will be send and published via GitHub. To subscribe them, you just have to watch this repository.

## Development
1. Clone git repository
2. Install npm packages
3. Link with ``npm start``
4. Run tests with ``npm test``
   
### Publishing
Increase version with ``npm version patch`` or ``npm version minor`` and push the commit and version tag. The npm package will be published via GitHub Actions.

### Troubleshooting
If you get the error ``SyntaxError: Unexpected token {``, you have to update your node version to at least Node 10.

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