Skip to content

chroma-js/chroma.js

 
 

Repository files navigation

Chroma.js

Chroma.js is a tiny small-ish zero-dependency JavaScript library for all kinds of color conversions and color scales. Forked with new features and maintained.

Build Status

Demo

Usage

In Deno:

import chroma from "https://github.com/chroma-js/chroma.js/index.js"; // CONTINUE proper URL

In Node.js install from npm

npm install chroma-js

Import package into project

import chroma from "chroma-js";

Initiate and manipulate colors:

chroma('#D4F880').darken().hex();  // #a1c550

Working with color scales is easy, too:

const scale = chroma.scale(['white', 'red']);
scale(0.5).hex(); // #FF7F7F

Lab/Lch interpolation looks better than RGB

chroma.scale(['white', 'red']).mode('lab');

Custom domains! Quantiles! Color Brewer!!

chroma.scale('RdYlBu').domain(myValues, 7, 'quantiles');

And why not use logarithmic color scales once in your life?

chroma.scale(['lightyellow', 'navy']).domain([1, 100000], 7, 'log');

Like it?

Why not dive into the interactive documentation (there's a static version, too). You can download chroma.min.js.

You can use it in node.js, too!

npm install chroma-js

You can use it in SASS using chromatic-sass!

You can use it in Deno, too!

import chroma from "https://github.com/chroma-js/chroma.js/index.js"; // CONTINUE proper URL

Minify

npm install terser -g
sh make.sh

Build instructions

First clone the repository and install the dev dependencies:

git clone git@github.com:chroma-js/chroma.js.git
cd chroma.js
npm install

Then compile the coffee-script source files to the build files:

npm run build

Don't forget to tests your changes! You will probably also want to add new test to the /test folder in case you added a feature.

npm test

And to update the documentation just run

npm run docs

To preview the docs locally you can use

npm run docs-preview

Similar Libraries / Prior Art

Authors

Chroma.js is written by these awesome contributors.

License

Released under BSD license. Versions prior to 0.4 were released under GPL.

Further reading

FAQ

There have been no commits in X weeks. Is chroma.js dead?

Yes! That's why it has been forked and now maintained here.

About

JavaScript library for all kinds of color manipulations

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 96.0%
  • HTML 3.5%
  • Other 0.5%