README
Colormaps
A package for the colormaps.io API.
Table of Contents
Installation
You can install this package from NPM:
npm add colormaps
Or with Yarn:
yarn add colormaps
CDN
For CDN, you can use unpkg:
https://unpkg.com/colormaps/dist/bundles/colormaps.umd.min.js
The global namespace for colormaps is colormaps
:
const {getList} = colormaps;
const items = await getList();
Usage
ES6
Get the list of colormap names:
import {getList} from 'colormaps';
const items = await getList();
Get a colormap by name:
import {getColormap} from 'colormaps';
const colormap = await getColormap('viridis');
// Get it in a different format
const hexColormap = await getColormap('viridis', 'hex');
Get a random colormap:
import {randomColormap} from 'colormaps';
const colormap = await randomColormap(2); // Colormap with 2 colors
Get a random color:
import {randomColor} from 'colormaps';
const {color} = await randomColor();
Search a colormap by name:
import {search} from 'colormaps';
const matches = await search({
name: 'vi'
});
Search a colormap by Euclidean distance:
import {search} from 'colormaps';
const matches = await search({
color: '#eee',
format: 'hex',
distance: 0.1
});
CommonJS
Get the list of colormap names:
const {getList} = require('colormaps');
const items = await getList();
Contribute
Releases are handled automatically by the CI using semantic-release.
If you wish to contribute, please use the following guidelines:
- Use Conventional Commits
- Use
[ci skip]
in commit messages to skip a build