ansi-styles

ANSI escape codes for styling strings in the terminal

You probably want the higher-level chalk module for styling your strings.

Install

1npm install ansi-styles

Usage

1import styles from 'ansi-styles';
2
3console.log(`${styles.green.open}Hello world!${styles.green.close}`);
4
5
6// Color conversion between 256/truecolor
7// NOTE: When converting from truecolor to 256 colors, the original color
8//       may be degraded to fit the new color palette. This means terminals
9//       that do not support 16 million colors will best-match the
10//       original color.
11console.log(`${styles.color.ansi(styles.rgbToAnsi(199, 20, 250))}Hello World${styles.color.close}`)
12console.log(`${styles.color.ansi256(styles.rgbToAnsi256(199, 20, 250))}Hello World${styles.color.close}`)
13console.log(`${styles.color.ansi16m(...styles.hexToRgb('#abcdef'))}Hello World${styles.color.close}`)

API

open and close

Each style has an open and close property.

modifierNames, foregroundColorNames, backgroundColorNames, and colorNames

All supported style strings are exposed as an array of strings for convenience. colorNames is the combination of foregroundColorNames and backgroundColorNames.

This can be useful if you need to validate input:

1import {modifierNames, foregroundColorNames} from 'ansi-styles';
2
3console.log(modifierNames.includes('bold'));
4//=> true
5
6console.log(foregroundColorNames.includes('pink'));
7//=> false

Styles

Modifiers

• reset
• bold
• dim
• italic (Not widely supported)
• underline
• overline Supported on VTE-based terminals, the GNOME terminal, mintty, and Git Bash.
• inverse
• hidden
• strikethrough (Not widely supported)

Colors

• black
• red
• green
• yellow
• blue
• magenta
• cyan
• white
• blackBright (alias: gray, grey)
• redBright
• greenBright
• yellowBright
• blueBright
• magentaBright
• cyanBright
• whiteBright

Background colors

• bgBlack
• bgRed
• bgGreen
• bgYellow
• bgBlue
• bgMagenta
• bgCyan
• bgWhite
• bgBlackBright (alias: bgGray, bgGrey)
• bgRedBright
• bgGreenBright
• bgYellowBright
• bgBlueBright
• bgMagentaBright
• bgCyanBright
• bgWhiteBright

Advanced usage

By default, you get a map of styles, but the styles are also available as groups. They are non-enumerable so they don't show up unless you access them explicitly. This makes it easier to expose only a subset in a higher-level module.

• styles.modifier
• styles.color
• styles.bgColor

Example

1import styles from 'ansi-styles';
2
3console.log(styles.color.green.open);

Raw escape codes (i.e. without the CSI escape prefix \u001B[ and render mode postfix m) are available under styles.codes, which returns a Map with the open codes as keys and close codes as values.

Example

1import styles from 'ansi-styles';
2
3console.log(styles.codes.get(36));
4//=> 39

16 / 256 / 16 million (TrueColor) support

ansi-styles allows converting between various color formats and ANSI escapes, with support for 16, 256 and 16 million colors.

The following color spaces are supported:

• rgb
• hex
• ansi256
• ansi

To use these, call the associated conversion function with the intended output, for example:

1import styles from 'ansi-styles';
2
3styles.color.ansi(styles.rgbToAnsi(100, 200, 15)); // RGB to 16 color ansi foreground code
4styles.bgColor.ansi(styles.hexToAnsi('#C0FFEE')); // HEX to 16 color ansi foreground code
5
6styles.color.ansi256(styles.rgbToAnsi256(100, 200, 15)); // RGB to 256 color ansi foreground code
7styles.bgColor.ansi256(styles.hexToAnsi256('#C0FFEE')); // HEX to 256 color ansi foreground code
8
9styles.color.ansi16m(100, 200, 15); // RGB to 16 million color foreground code
10styles.bgColor.ansi16m(...styles.hexToRgb('#C0FFEE')); // Hex (RGB) to 16 million color foreground code

Related

• ansi-escapes - ANSI escape codes for manipulating the terminal

Maintainers

• Sindre Sorhus
• Josh Junon

For enterprise

Available as part of the Tidelift Subscription.

The maintainers of ansi-styles and thousands of other packages are working with Tidelift to deliver commercial support and maintenance for the open source dependencies you use to build your applications. Save time, reduce risk, and improve code health, while paying the maintainers of the exact dependencies you use. Learn more.