https://github.com/sina-byn/node-color-picker

A simple terminal color picker for Node.js
https://github.com/sina-byn/node-color-picker

cli ink javascript nodejs react terminal typescript

Last synced: 6 months ago
JSON representation

A simple terminal color picker for Node.js

• Host: GitHub
• URL: https://github.com/sina-byn/node-color-picker
• Owner: sina-byn
• License: mit
• Created: 2025-01-03T19:26:32.000Z (9 months ago)
• Default Branch: main
• Last Pushed: 2025-04-05T07:15:10.000Z (6 months ago)
• Last Synced: 2025-04-05T11:35:35.208Z (6 months ago)
• Topics: cli, ink, javascript, nodejs, react, terminal, typescript
• Language: TypeScript
• Homepage: https://www.npmjs.com/package/node-color-picker
• Size: 287 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# node-color-picker [![NPM version](https://img.shields.io/npm/v/node-color-picker.svg?style=flat)](https://www.npmjs.com/package/node-color-picker) [![NPM monthly downloads](https://img.shields.io/npm/dm/node-color-picker.svg?style=flat)](https://npmjs.org/package/node-color-picker) [![NPM total downloads](https://img.shields.io/npm/dt/node-color-picker.svg?style=flat)](https://npmjs.org/package/node-color-picker)

A simple terminal color picker for Node.js.

Please consider following this project's author, [Sina Bayandorian](https://github.com/sina-byn), and consider starring the project to show your :heart: and support.

> If you're building an interactive CLI with Ink, be sure to check out [ink-color-picker](https://www.npmjs.com/package/ink-color-picker) for a powerful and user-friendly Ink component.

![Demo GIF](assets/demo.gif)

## Installation

```shell

npm i node-color-picker

```

## Usage

```js

// * index.js

import { colorPicker } from 'node-color-picker';

const app = async () => {

  const color = await colorPicker();

  console.log(color);

};

app();

```

Then run :

```shell

node index.js

```

## Options

|      | Type    | Default | Description                     |

| ---- | ------- | ------- | ------------------------------- |

| hint | boolean | `True`  | Whether to show the hint or not |

---

```

colorPicker(options);

```