readme
Terminal string styling done right
colors.js is currently the most popular string styling module, but it has serious deficiencies like extending String.prototype which causes all kinds of problems. Although there are other ones, they either do too much or not enough.
Chalk is a clean and focused alternative.
Why
Doesn't extend String.prototype
Expressive API
Clean and focused
Auto-detects color support
Actively maintained
Install
Install with npm: npm install --save chalk
Example
Chalk comes with an easy to use composable API where you just chain and nest the styles you want.
You can easily define your own themes.
API
chalk.<style>[.<style>...](string, [string...])
<style>[.<style>...](string, [string...])
Example: chalk.red.bold.underline('Hello', 'world');
Chain styles and call the last one as a method with a string argument. Order doesn't matter.
Multiple arguments will be separated by space.
chalk.enabled
Color support is automatically detected, but you can override it.
chalk.supportsColor
Detect whether the terminal supports color.
Can be overridden by the user with the flags --color
and --no-color
.
Used internally and handled for you, but exposed for convenience.
chalk.styles
Exposes the styles as ANSI escape codes.
Generally not useful, but you might need just the .open
or .close
escape code if you're mixing externally styled strings with yours.
chalk.stripColor(string)
Strip color from a string.
Can be useful in combination with .supportsColor
to strip color on externally styled text when it's not supported.
Example:
Styles
General
reset
bold
italic
underline
inverse
strikethrough
Text colors
black
red
green
yellow
blue
magenta
cyan
white
gray
Background colors
bgBlack
bgRed
bgGreen
bgYellow
bgBlue
bgMagenta
bgCyan
bgWhite
License
MIT © Sindre Sorhus
-
Last updated