chroma.js README

The project's README from github.com/gka/chroma.js. As one markdown file: README.md.

Chroma.js

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

Build Status Build size

Usage

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:

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 or use the hosted version on unpkg.com.

You can use it in node.js, too!

npm install chroma-js

Or you can use it in SASS using chromatic-sass!

Want to contribute?

Come over and say hi in our Discord channel!

Build instructions

First clone the repository and install the dev dependencies:

git clone [email protected]:gka/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

Author

Chroma.js is written by Gregor Aisch.

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?

No! It's just that the author of this library has other things to do than devoting every week of his life to making cosmetic changes to a piece of software that is working just fine as it is, just so that people like you don't feel like it's abandoned and left alone in this world to die. Bugs will be fixed. Some new things will come at some point. Patience.

I want to help maintaining chroma.js!

Yay, that's awesome! Please say hi at our Discord chat to get in touch

chroma.js (gka/chroma.js)

Searching Database…

10.6K ·GitHub
Chroma.js
Что это такое?Chroma.js — это небольшая JavaScript-библиотека без зависимостей для всевозможных преобразований цветов и цветовых шкал — от разбора одного цвета до построения многоцветных палитр.
Это для браузера или для Node?И то и другое — работает в браузере через отдельный файл chroma.min.js или сборку с unpkg.com, а в node.js — из npm. Есть даже дополнение chromatic-sass, чтобы использовать её в SASS.
Как добавить её в свой проект?Установите из npm командой 'npm install chroma-js', подключите пакет в своём проекте — и можно создавать цвета и работать с ними.
Коммитов не было уже несколько недель — chroma.js умер?Нет — автор отвечает на это напрямую: библиотека прекрасно работает как есть, баги будут исправляться, а новое появится со временем, так что оценивайте её по стабильности, а не по частоте коммитов.
Можно пользоваться бесплатно, в том числе в коммерческих проектах?Да — chroma.js распространяется по лицензии BSD. Только версии до 0.4 выходили под GPL, так что любая современная версия подходит.
Что она умеет, кроме преобразования одного цвета?Вторая главная возможность — цветовые шкалы: интерполяция в Lab/Lch, которая выглядит лучше обычного RGB, пользовательские домены, квантили, палитры Color Brewer и логарифмические шкалы.
Она работает с SASS?Да — есть дополнительный пакет под названием chromatic_sass для использования chroma.js в SASS.
Есть похожие библиотеки для других языков?В README перечислены GrapeFruit и colors.py для Python, Color Art для Rust, а также Chromatist и d3.js для JavaScript.
What are similar projects?highlight.js, core-js, validator.js, tween.js, charts, cdnjs, wavesurfer.js, prism
Which topics is it in?colors, domains, static, cdn, front-end, zero-dependency, interactive, node, data-visualization, javascript-library, bsd, web-development
Creator
gka
Size
3.3 MB
Stars
10.6K
Updated
CommitSep 14Releasev3.2.0Nov 28
Age
14y
Commits · 90 Days