https://github.com/unional/color-map-rainbow
Creates rainbow of colors
https://github.com/unional/color-map-rainbow
color color-palette rainbow
Last synced: 7 months ago
JSON representation
Creates rainbow of colors
- Host: GitHub
- URL: https://github.com/unional/color-map-rainbow
- Owner: unional
- License: mit
- Created: 2017-01-08T07:16:44.000Z (almost 9 years ago)
- Default Branch: main
- Last Pushed: 2024-09-27T12:47:46.000Z (about 1 year ago)
- Last Synced: 2024-10-15T09:22:48.369Z (12 months ago)
- Topics: color, color-palette, rainbow
- Language: TypeScript
- Homepage: https://unional.github.io/color-map-rainbow/
- Size: 1.73 MB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# color-map-rainbow
[![NPM version][npm-image]][npm-url]
[![NPM downloads][downloads-image]][downloads-url]
![badge-size-es5-url]
![badge-size-es2015-url]
[![stable][stable-image]][stable-url]
[![GitHub NodeJS][github-nodejs]][github-action-url]
[![Codecov][codecov-image]][codecov-url]
[![Semantic Release][semantic-release-image]][semantic-release-url]
[![Visual Studio Code][vscode-image]][vscode-url]
Create rainbow of colors with minimal dependency.
Inspired from [`color-rainbow`]
## `createRainbow(shades)`
```ts
import { createRainbow } from 'color-map-rainbow'
import { rgbHex, rgbaString } from 'color-map'
// rainbow = array of [r,g,b,a=1]
const rainbow = createRainbow(72)
// transparentRainbow = array of [r,g,b, 0...0.8]
const transparentRainbow = createRainbow(72, [0, 0.8])
// use `color-map` conversion function to get
// '#000000' or 'rgba(...)`
const hexRainbow = rainbow.map(c => rgbHex(c))
const rgbaRainbow = rainbow.map(c => rgbaString(c))
```
## Contribute
```sh
# right after clone
npm install
# begin making changes
git checkout -b
npm run watch
# edit `webpack.config.es5.js` and `rollup.config.es2015.js` to exclude dependencies for the bundle if needed
# after making change(s)
git commit -m ""
git push
# create PR
```
## NPM Commands
There are a few useful commands you can use during development.
```sh
# Run tests (and lint) automatically whenever you save a file.
npm run watch
# Run tests with coverage stats (but won't fail you if coverage does not meet criteria)
npm run test
# Manually verify the project.
# This will be ran during 'npm preversion' so you normally don't need to run this yourself.
npm run verify
# Build the project.
# You normally don't need to do this.
npm run build
# Run tslint
# You normally don't need to do this as `npm run watch` and `npm version` will automatically run lint for you.
npm run lint
```
[`color-rainbow`]: https://github.com/grant/color-rainbow
[badge-size-es5-url]: http://img.badgesize.io/unional/color-map-rainbow/master/dist/color-map-rainbow.es5.js.svg?label=es5_size
[badge-size-es2015-url]: http://img.badgesize.io/unional/color-map-rainbow/master/dist/color-map-rainbow.es2015.js.svg?label=es2015_size
[codecov-image]: https://codecov.io/gh/unional/color-map-rainbow/branch/master/graph/badge.svg
[codecov-url]: https://codecov.io/gh/unional/color-map-rainbow
[downloads-image]: https://img.shields.io/npm/dm/color-map-rainbow.svg?style=flat
[downloads-url]: https://npmjs.org/package/color-map-rainbow
[github-action-url]: https://github.com/unional/color-map-rainbow/actions
[github-nodejs]: https://github.com/unional/color-map-rainbow/workflows/nodejs/badge.svg
[npm-image]: https://img.shields.io/npm/v/color-map-rainbow.svg?style=flat
[npm-url]: https://npmjs.org/package/color-map-rainbow
[semantic-release-image]: https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg
[semantic-release-url]: https://github.com/semantic-release/semantic-release
[stable-image]: http://badges.github.io/stability-badges/dist/stable.svg
[stable-url]: http://github.com/badges/stability-badges
[vscode-image]: https://img.shields.io/badge/vscode-ready-green.svg
[vscode-url]: https://code.visualstudio.com/