palettee v1.0.2

palettee

Generates a random colour palette.

Check out the demo!

Installation

npm install palettee

Usage

Basic Usage

const Palettee = require("palettee"); 
const palettee = new Palettee();
palettee.palette(); // ["#000000", "#000000", "#000000", "#000000", "#000000"]
palettee.color(); // "#000000"

Configuration

You can pass a configuration object into the constructor:

const palettee = new Palettee({
      size: 3,
      format: "hex",
  });
palettee.palette(); // ["#000000", "#000000", "#000000"]
palettee.palette(); // ["#000000", "#000000", "#000000"]
palettee.palette(); // ["#000000", "#000000", "#000000"]

Or you can pass the configuration object into each palette() call. This will overwrite any configurations passed into the constructor for that single palette generator call:

const palettee = new Palettee();
const palette = palettee.palette(3); // ["#000000", "#000000", "#000000"]
const palette = palettee.palette({
    scheme: ["monochrome"],
    size: 3,
    format: "hex",
}); // ["#000000", "#000000", "#000000"]

Reference

Configuration Object

Palettee

Palette

Color