Skip to content

πŸ‘¨β€πŸŽ¨ Turbo-powered color schemes for JS

License

Notifications You must be signed in to change notification settings

Knogobert/tpcs.js

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

25 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

πŸ‘¨β€πŸŽ¨ tpcs.js β€” Turbo-Powered Color Schemes

turbo-colormap

npm downloads npm version license

Turbo is a rainbow colormap

tpcs.js is based on Rex Riepe's TPCS for LESS (and his demo site)

It creates color schemes like this:

image

Install

npm install --save tpcs.js

Usage

Import tpcs.js in your preferred way.

import tpcs from 'tpcs.js';

Then call the function and pass along a hexadecimal color-code string as argument Or pass an array with RGB values 0-255, syntaxed as [R, G, B].

tpcs('#B4D4AA')
// OR
tpcs([220, 20, 60])

This returns an object with the generated color scheme, where the values are RGB-arrays, syntaxed as [R, G, B].

{
  "baseColor": [180, 212, 170],
  "action": [96, 243, 54],
  "reaction": [196, 93, 81],
  "alternate": [253, 175, 75],
  "accent": [223, 242, 62],
  "info": [93, 204, 240],
  "success": [165, 247, 52],
  "warning": [253, 200, 40],
  "failure": [233, 149, 137],
  "highlight": [255, 255, 94]
}

Contributing

Clone this repository and install its dependencies:

git clone https://github.com/Knogobert/tpcs.js
cd tpcs.js
npm install

npm run build builds the library to dist, generating three files:

  • dist/tpcs.cjs.js A CommonJS bundle, suitable for use in Node.js, that requires the external dependency. This corresponds to the "main" field in package.json
  • dist/tpcs.esm.js an ES module bundle, suitable for use in other people's libraries and applications, that imports the external dependency. This corresponds to the "module" field in package.json
  • dist/tpcs.umd.js a UMD build, suitable for use in any environment (including the browser, as a <script> tag), that includes the external dependency. This corresponds to the "browser" field in package.json

npm run dev builds the library, then keeps rebuilding it whenever the source files change using rollup-watch.

node -r esm "./src/tpcs.js" to run the file directly in node with esm module support.