color2k

a color parsing and manipulation lib served in roughly 2kB

Colors
ricokahler/color2kcolor2k.comcolor2k

README

color2k

bundlephobia github status checks codecov weekly downloads semantic-release

a color parsing and manipulation lib served in roughly 2kB or less (2.8kB to be more precise)


color2k is a color parsing and manipulation library with the objective of keeping the bundle size as small as possible while still satisfying all of your color manipulation needs in an sRGB space.

The full bundle size is currently 2.8kB but gets as small as 2.1k with tree shaking.

Size comparison


libsize
--------------------------------------------------------------------------------------------------------------
[chroma-js](https://github.com/gka/chroma.js)[13.7kB](https://bundlephobia.com/result?p=chroma-js)
[polished](https://github.com/styled-components/polished)[11.2kB](https://bundlephobia.com/result?p=polished)
[color](https://github.com/Qix-/color)[7.6kB](https://bundlephobia.com/result?p=color)
[tinycolor2](https://github.com/bgrins/TinyColor)[5kB](https://bundlephobia.com/result?p=tinycolor2)
color2k[2.8kB](https://bundlephobia.com/result?p=color2k)

👋 Compare tree-shaken bundle outputs on bundlejs.com

Installation


Install with a package manager such as npm

  1. ```
  2. npm i color2k
  3. ```

OR use with skypack.dev in supported environments (e.g. deno, modern browsers).

  1. ``` js
  2. import { darken, transparentize } from 'https://cdn.skypack.dev/color2k?min';
  3. ```

Usage


  1. ``` js
  2. import { darken, transparentize } from 'color2k';

  4. // e.g.
  5. darken('blue', 0.1);
  6. transparentize('red', 0.5);
  7. ```

How so small?


There are two secrets that keep this lib especially small:

1. Simplicity — only handles basic color manipulation functions
2. Less branching in code — only support two color models as outputs, namely rgba and hsla

Why only rgba and hsla as outputs?


This lib was created with the use case of CSS-in-JS in mind. At the end of the day, all that matters is that the browser can understand the color string you gave it as a background-color.

Because only those two color models are supported, we don't have to add code to deal with optional alpha channels or converting to non-browser supported color models (e.g. CMYK).

We believe that this lib is sufficient for all of your color manipulation needs. If we're missing a feature, feel free to open an issue 😎.

Credits


Heavy credits goes to polished.js and sass. Much of the implementation of this lib is copied from polished!



API and Documentation


Head over to the docs site