Let users toggle colors.
This is a thin wrapper around the popular
chalk colors library that adds support for:
Example
import colorsOption from 'colors-option'
const exampleLibrary = ({ colors, ... otherLibraryOptions }) => {
const chalk = colorsOption ({ colors })
console. log (chalk. red ( 'example' ))
} copy
Install
npm install colors-option copy
This package works in Node.js >=18.18.0.
This is an ES module. It must be loaded using
an import or import() statement ,
not require(). If TypeScript is used, it must be configured to
output ES modules ,
not CommonJS.
API
colorsOption(options?)
options: object
Return value : Chalk instance
options
colors
Type : boolean
Whether colors should be displayed or not.
The default value depends on whether the stream supports colors.
Therefore, this is only meant to override that.
Instead of using
chalk/supports-color , the default
value relies on Node.js built-in colors detection
getColorDepth()
which:
Supports the NO_COLOR and
NODE_DISABLE_COLORS
environment variables.
Does not guess colors detection based on the presence of a
--colors CLI flag . This
gives finer control and flexibility over how to expose this as a CLI flag.
level
Type : 1 | 2 | 3
How many colors to
display. The value can be:
1: 16 (4 bits)
2: 256 (8 bits)
3: 16 millions (24 bits)
The default value depends on
how many colors
the stream supports. Therefore, this is only meant to override
that.
stream
Type :
Stream
Default : process.stdout
Stream used to detect the default value of the colors and
level options.
This should be the file or terminal where the colors are output.
See also
chalk-string : Chalk with style
strings.
terminal-theme : 🎨 Use a color
theme for your code's terminal output.
Support
For any question, don't hesitate to submit an issue on GitHub .
Everyone is welcome regardless of personal background. We enforce a
Code of conduct in order to promote a positive and
inclusive environment.
Contributing
This project was made with ❤️. The simplest way to give back is by starring and
sharing it online.
If the documentation is unclear or has a typo, please click on the page's Edit
button (pencil icon) and suggest a correction.
If you would like to help us fix a bug or add a new feature, please check our
guidelines . Pull requests are welcome!