chroma-palette
TypeScript icon, indicating that this package has built-in type declarations

1.2.2 • Public • Published

Chroma-Palette

A light-weight utility for coloring your terminal. 0 dependencies. Default is a preselected color output from the 256 color palette, chosen to enhance legibility.

Features:

  • Chainable using the push() method without having to call chromaPalette more than once.
  • 0 dependencies.
  • Has internal function to print all 256 color options.
  • Fully customizable.
  • Has internal properties to provide easier formatting.
  • Has examples. Run node <path to node_modules>/chroma-palette/examples/<example>

Table of Contents

  1. Install
  2. Usage
  3. Properties
  4. Methods

Install

npm i chroma-palette 

Usage

Default (256-Color Set):

Default is a preselected color output from the 256 color palette, chosen to enhance legibility.

const chromaPalette = require('chroma-palette')

// chaining content with push()
console.log(
  chromaPalette
    .cyan.push('Hello')
    .space.magenta.paint('World!') // here space adds a literal space to elements
);
// chaining
console.log(
  chromaPalette
    .blue.whiteBg.bold.paint('Hello World!')
);
// combine
console.log(
  chromaPalette.blue.paint('Hello ') + chromaPalette.bold.paint('World') + '!'
);
// template literal
console.log(
  `${chromaPalette.blue.paint('Hello')} ${chromaPalette.bold.paint('World')}!`
);

16-Color Set Support:

If you need to alter the output of the colors to support the 16-color set.

const { ChromaPalette } = require('chroma-palette')
// change profile to 16
const chromaPalette = new ChromaPalette({ profile:'16' })

// output will be the cyan from the 16-color palette
console.log(
  chromaPalette
    .cyan.paint('Hello World!')
);

Custom-Color Set Support:

If you want to change the output of various colors.

const { ChromaPalette } = require('chroma-palette')
// change any color by { [COLOR]:'[NUMBER FROM 256]' }
const chromaPalette = new ChromaPalette({ red:'196' })

// output will be the custom red chosen
console.log(
  chromaPalette
    .red.paint('Hello World!')
);

View the 256 Color Palette:

Helpful when choosing custom colors.

const chromaPalette = require('chroma-palette')

// output the 256-color palette
console.log(
  chromaPalette
    .palette.paint()
);

Properties

Formatters:

  • space - Will output a space after calling paint().
  • enter - Will output a return character after calling paint().

Modifiers:

  • dim - Small amount of light.
  • underscore - Underline text.
  • blink - Blink.
  • reverse- Reverse.
  • hidden - Hides text.
  • bold - Bold text.

Color:

  • blue - Blue text.
  • cyan - Cyan text.
  • purple - Purple text.
  • magenta - Magenta text.
  • red - Red text.
  • orange - Orange text.
  • yellow - Yellow text.
  • green - Green text.
  • white - White text.
  • black - Black text.
  • blueBg - Blue background.
  • cyanBg - Cyan background.
  • purpleBg - Purple background.
  • magentaBg - Magenta background.
  • redBg - Red background.
  • orangeBg - Orange background.
  • yellowBg - Yellow background.
  • greenBg - Green background.
  • whiteBg - White background.
  • blackBg - Black background.

Methods

Functions:

  • push(string) - Pushes the string to the elements and resets colors | modifiers. Makes chromaPalette chainable without having to call chromaPalette multiple times.
  • paint(string) - Outputs the created string. Must be called after everything else to return the string.

Package Sidebar

Install

npm i chroma-palette

Weekly Downloads

19

Version

1.2.2

License

MIT

Unpacked Size

21.3 kB

Total Files

9

Last publish

Collaborators

  • clyng57