An open API service indexing awesome lists of open source software.

https://github.com/randplus/color

A package that adds functions for random.
https://github.com/randplus/color

color hex name nodejs npm package random rgb

Last synced: 5 months ago
JSON representation

A package that adds functions for random.

Awesome Lists containing this project

README

          

# @randplus/color
Generate random colors.

This package is included in '[randplus](https://www.npmjs.com/package/randplus)'.

###### Teams
OTONEKO.CAT

## Usage
```js
// Classic
const random = require('@randplus/color');

console.log(random('hex')); // '000000' ~ 'ffffff'
console.log(random('hex', { prefix: '#' })); // '#000000' ~ '#ffffff'
console.log(random('rgb')); // [0, 0, 0] ~ [255, 255, 255]
console.log(random('word')); // 'limegreen'
console.log(random('word', { language: 'ja' })); // '鉄色'
```
```js
// Advanced
const { hex, rgb, word } = require('@randplus/color');

console.log(hex()); // '000000' ~ 'ffffff'
console.log(hex('#')); // '#000000' ~ '#ffffff'
console.log(rgb()); // [0, 0, 0] ~ [255, 255, 255]
console.log(word()); // 'limegreen'
console.log(word('cn')); // '紫磨金'
```

### Get Color Name Example:
Install [color-name-lib](https://www.npmjs.com/package/color-name-lib).
```sh
npm i color-name-lib
```
```js
const { hex } = require('@randplus/color');
const colorName = require('color-name-lib');

const colorHex = hex();
const name = colorName(colorHex);
console.log(`${colorHex}: ${name}`);
```
or use `lib/color-name-lib.js`.
```js
const { hex } = require('@randplus/color');
const colorName = require('@randplus/color/lib/color-name-lib');

const colorHex = hex();
const name = colorName(colorHex);
console.log(`${colorHex}: ${name}`);
```