https://github.com/kabeep/palette
๐จ A Node.js library for terminal text colour & style in FP.
https://github.com/kabeep/palette
ansi chalk cli color console nodejs terminal
Last synced: 5 months ago
JSON representation
๐จ A Node.js library for terminal text colour & style in FP.
- Host: GitHub
- URL: https://github.com/kabeep/palette
- Owner: kabeep
- License: mit
- Created: 2025-01-20T17:24:02.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2025-10-22T10:37:06.000Z (9 months ago)
- Last Synced: 2025-10-22T11:30:47.483Z (9 months ago)
- Topics: ansi, chalk, cli, color, console, nodejs, terminal
- Language: TypeScript
- Homepage: https://kabeep.github.io/palette/
- Size: 181 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Palette
๐จ A Node.js library for terminal text colour & style in FP.
[![NodeJS][node-image]][node-url]
[![License][license-image]][license-url]
[![NPM][npm-image]][npm-url]
[![Codecov][codecov-image]][codecov-url]
[![BundlePhobia][bundle-phobia-image]][bundle-phobia-url]
[![CircleCI][circleci-image]][circleci-url]
English | [็ฎไฝไธญๆ][zh-cn-url]
## ๐ Introduction
> `chalk` offers a user-friendly, chainable API.
> In spite of the excellent work done by @sindresorhus to reduce the size of the packaging as much as possible.
> But my view is that the key issue is not ["Why not switch to a smaller coloring package?"][chalk-faq-url].
> Hereโs why:
> - No tree-shaking support, and no FP such as pipe/compose.
> - You will still need to create the full `chalk` using the factory function
> if you only need to colour the red failure and green success messages.
> - In lightweight scenarios, _static ANSI strings_ are much more cost-effective.
So I created this package.
It supports ANSI _16 colours_, _256 colours_ and _16 million true colours_ like `chalk`.
Compared to other lightweight alternatives, it goes beyond basic ANSI keywords and also supports
_[Hex Triplet][hex-triplet-url]_, _[RGB Color Model][rgb-model-url]_, and _[CSS Keywords][css-keywords-url]_.
But this does not mean it compromises on **size** or **performance**.
On the contrary, it performs excellently in [Benchmark Reports][perf-en-us-url].
Of course, all the coloring packages are more than fast enough,
I am just saying `@kabeep/palette` is a good choice for people who value size and performance.
See [documentation][docs-url].
## ๐ฆ Installation
```bash
npm install @kabeep/palette --save
```
```bash
yarn add @kabeep/palette
```
```bash
pnpm add @kabeep/palette
```
## โ๏ธ Usage
**CommonJS**
```typescript
const pipe = require('lodash.flow');
const { bgRgb, hex, keyword, yellowBright } = require('@kabeep/palette');
const padding = (text: string) => ` ${text} `;
const palette = pipe(keyword('gold'), padding, bgRgb(255, 0, 0));
console.log(palette('Error'), yellowBright('Warning'), hex('#ff0000')('Message'));
```
**ESModule**
```typescript
import pipe from 'lodash.flow';
import { bgRgb, hex, keyword, yellowBright } from '@kabeep/palette';
const padding = (text: string) => ` ${text} `;
const palette = pipe(keyword('gold'), padding, bgRgb(255, 0, 0));
console.log(palette('Error'), yellowBright('Warning'), hex('#ff0000')('Message'));
```
## ๐ Styles
### Modifiers
- reset - Reset the current style.
- bold - Make the text bold.
- dim - Make the text have lower opacity.
- italic - Make the text italic. (Not widely supported)
- underline - Put a horizontal line above the text. (Not widely supported)
- overline - Put a horizontal line below the text. (Not widely supported)
- inverse- Invert background and foreground colors.
- hidden - Print the text but make it invisible.
- strikethrough - Put a horizontal line through the center of the text. (Not widely supported)
### Foreground Colors
- black
- red
- green
- yellow
- blue
- magenta
- cyan
- white
- gray
- redBright
- greenBright
- yellowBright
- blueBright
- magentaBright
- cyanBright
- whiteBright
### Background Colors
- bgBlack
- bgRed
- bgGreen
- bgYellow
- bgBlue
- bgMagenta
- bgCyan
- bgWhite
- bgGray
- bgRedBright
- bgGreenBright
- bgYellowBright
- bgBlueBright
- bgMagentaBright
- bgCyanBright
- bgWhiteBright
### Hex Triplet
- hex - (three-digit) #fff, ...
- hex - (six-digit) #ffffff, ...
- hex - (without hashtag) fff, ffffff, ...
### RGB Color Model
- rgb - (255, 255, 255), ...
### CSS Color Keywords
See the full list at [W3C Wiki][css-keywords-url].
- keyword - azure, gold, indigo, ...
## ๐ Credits
- [ansi-styles][ansi-styles-url] - Implement hexToRgb function.
- [chalk-pipe][chalk-pipe-url] - Collating cssKeywords data.
- [yoctocolors][yoctocolors-url] - Implement format function & style description.
## ๐ Related
- [palette-cli][palette-cli-url] - A Node.js Library to make your terminal input colorful.
## ๐ค Contribution
Contributions via Pull Requests or [Issues][issues-url] are welcome.
## ๐ License
This project is licensed under the MIT License. See the [LICENSE][license-url] file for details.
[node-image]: https://img.shields.io/node/v/%40kabeep%2Fpalette?color=lightseagreen "Node.js Version"
[node-url]: https://nodejs.org
[npm-image]: https://img.shields.io/npm/d18m/%40kabeep%2Fpalette?color=cornflowerblue "NPM Downloads"
[npm-url]: https://www.npmjs.com/package/@kabeep/palette
[codecov-image]: https://img.shields.io/codecov/c/github/kabeep/palette?logo=codecov&color=mediumvioletred "Test Coverage"
[codecov-url]: https://codecov.io/gh/kabeep/palette
[bundle-phobia-image]: https://img.shields.io/bundlephobia/minzip/@kabeep/palette "Bundle Size"
[bundle-phobia-url]: https://bundlephobia.com/package/@kabeep/palette
[circleci-image]: https://dl.circleci.com/status-badge/img/gh/kabeep/palette/tree/master.svg?style=shield "Build Status"
[circleci-url]: https://dl.circleci.com/status-badge/redirect/gh/kabeep/palette/tree/master
[hex-triplet-url]: https://en.wikipedia.org/wiki/Web_colors#Hex_triplet
[rgb-model-url]: https://en.wikipedia.org/wiki/RGB_color_model
[css-keywords-url]: https://www.w3.org/wiki/CSS/Properties/color/keywords
[ansi-styles-url]: https://github.com/chalk/chalk/blob/main/source/vendor/ansi-styles/index.js#L134
[chalk-pipe-url]: https://github.com/LitoMore/chalk-pipe/blob/main/source/styles.ts
[yoctocolors-url]: https://github.com/sindresorhus/yoctocolors/blob/main/base.js#L27
[chalk-faq-url]: https://github.com/chalk/chalk?tab=readme-ov-file#why-not-switch-to-a-smaller-coloring-package
[palette-cli-url]: https://github.com/kabeep/palette-cli
[license-image]: https://img.shields.io/github/license/kabeep/palette?color=slateblue "License"
[license-url]: LICENSE
[perf-en-us-url]: performance/PERFORMANCE.md
[zh-cn-url]: README.zh-CN.md
[docs-url]: https://kabeep.github.io/palette
[issues-url]: https://github.com/kabeep/palette/issues