Easily add ANSI colors to your text and symbols in the terminal. A faster drop-in replacement for chalk, kleur and turbocolor (without the dependencies and rendering bugs).
Please consider following this project's author, Brian Woodward, and consider starring the project to show your :heart: and support.
Install with npm:
sh
$ npm install --save ansi-colors
ansi-colors is the fastest Node.js library for terminal styling. A more performant drop-in replacement for chalk, with no dependencies.
Blazing fast - Fastest terminal styling library in node.js, 10-20x faster than chalk!
Drop-in replacement for chalk.
No dependencies (Chalk has 7 dependencies in its tree!)
Safe - Does not modify the String.prototype like colors.
```js const c = require('ansi-colors');
console.log(c.red('This is a red string!')); console.log(c.green('This is a red string!')); console.log(c.cyan('This is a cyan string!')); console.log(c.yellow('This is a yellow string!')); ```
js
console.log(c.bold.red('this is a bold red message'));
console.log(c.bold.yellow.italic('this is a bold yellow italicized message'));
console.log(c.green.bold.underline('this is a bold green underlined message'));
js
console.log(c.yellow(`foo ${c.red.bold('red')} bar ${c.cyan('cyan')} baz`));
ansi-colors does not have the nested styling bug found in colorette, chalk, and kleur.
``js
const { bold, red } = require('ansi-styles');
console.log(bold(foo ${red.dim('bar')} baz`));
const colorette = require('colorette');
console.log(colorette.bold(foo ${colorette.red(colorette.dim('bar'))} baz));
const kleur = require('kleur');
console.log(kleur.bold(foo ${kleur.red.dim('bar')} baz));
const chalk = require('chalk');
console.log(chalk.bold(foo ${chalk.red.dim('bar')} baz));
```
Results in the following
(sans icons and labels)
Easily enable/disable colors.
```js const c = require('ansi-colors');
// disable colors manually c.enabled = false;
// or use a library to automatically detect support c.enabled = require('color-support').hasBasic;
console.log(c.red('I will only be colored red if the terminal supports colors')); ```
Use the .unstyle method to strip ANSI codes from a string.
js
console.log(c.unstyle(c.blue.bold('foo bar baz')));
//=> 'foo bar baz'
Note that bright and bright-background colors are not always supported.
| Colors | Background Colors | Bright Colors | Bright Background Colors | | ------- | ----------------- | ------------- | ------------------------ | | black | bgBlack | blackBright | bgBlackBright | | red | bgRed | redBright | bgRedBright | | green | bgGreen | greenBright | bgGreenBright | | yellow | bgYellow | yellowBright | bgYellowBright | | blue | bgBlue | blueBright | bgBlueBright | | magenta | bgMagenta | magentaBright | bgMagentaBright | | cyan | bgCyan | cyanBright | bgCyanBright | | white | bgWhite | whiteBright | bgWhiteBright | | gray | | | | | grey | | | |
(gray is the U.S. spelling, grey is more commonly used in the Canada and U.K.)
bold
hidden
italic
underline
~~strikethrough~~
reset
Libraries tested
MacBook Pro, Intel Core i7, 2.3 GHz, 16 GB.
Load time
Time it takes to load the first time require() is called:
1.915ms12.437msBenchmarks
```
ansi-colors x 173,851 ops/sec ±0.42% (91 runs sampled) chalk x 9,944 ops/sec ±2.53% (81 runs sampled)))
ansi-colors x 20,791 ops/sec ±0.60% (88 runs sampled) chalk x 2,111 ops/sec ±2.34% (83 runs sampled)
ansi-colors x 59,304 ops/sec ±0.98% (92 runs sampled) chalk x 4,590 ops/sec ±2.08% (82 runs sampled) ```
Windows 10, Intel Core i7-7700k CPU @ 4.2 GHz, 32 GB
Load time
Time it takes to load the first time require() is called:
1.494ms11.523msBenchmarks
```
ansi-colors x 193,088 ops/sec ±0.51% (95 runs sampled)) chalk x 9,612 ops/sec ±3.31% (77 runs sampled)))
ansi-colors x 26,093 ops/sec ±1.13% (94 runs sampled) chalk x 2,267 ops/sec ±2.88% (80 runs sampled))
ansi-colors x 67,747 ops/sec ±0.49% (93 runs sampled) chalk x 4,446 ops/sec ±3.01% (82 runs sampled)) ```
You might also be interested in these projects:
| Commits | Contributor |
| --- | --- |
| 42 | doowb |
| 38 | jonschlinkert |
| 6 | lukeed |
| 2 | Silic0nS0ldier |
| 1 | dwieeb |
| 1 | jorgebucaran |
| 1 | madhavarshney |
| 1 | chapterjason |
Brian Woodward
Please consider supporting me on Patreon, or start your own Patreon page!
Copyright © 2019, Brian Woodward. Released under the MIT License.
This file was generated by verb-generate-readme, v0.8.0, on March 03, 2019.