ansi-styles
ANSI escape codes for styling strings in the terminal
You probably want the higher-level chalk module for styling your strings.
Install
npm install ansi-styles
Usage
const style = ; console; // Color conversion between 16/256/truecolor// NOTE: If conversion goes to 16 colors or 256 colors, the original color// may be degraded to fit that color palette. This means terminals// that do not support 16 million colors will best-match the// original color.console;console;console;
API
Each style has an open
and close
property.
Styles
Modifiers
reset
bold
dim
italic
(Not widely supported)underline
inverse
hidden
strikethrough
(Not widely supported)
Colors
black
red
green
yellow
blue
magenta
cyan
white
gray
("bright black")redBright
greenBright
yellowBright
blueBright
magentaBright
cyanBright
whiteBright
Background colors
bgBlack
bgRed
bgGreen
bgYellow
bgBlue
bgMagenta
bgCyan
bgWhite
bgBlackBright
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.
style.modifier
style.color
style.bgColor
Example
console;
Raw escape codes (i.e. without the CSI escape prefix \u001B[
and render mode postfix m
) are available under style.codes
, which returns a Map
with the open codes as keys and close codes as values.
Example
console;//=> 39
256 / 16 million (TrueColor) support
ansi-styles
uses the color-convert
package to allow for converting between various colors and ANSI escapes, with support for 256 and 16 million colors.
To use these, call the associated conversion function with the intended output, for example:
stylecoloransi; // RGB to 16 color ansi foreground codestylebgColoransi; // RGB to 16 color ansi background code stylecoloransi256; // HSL to 256 color ansi foreground codestylebgColoransi256; // HSL to 256 color ansi foreground code stylecoloransi16m; // Hex (RGB) to 16 million color foreground codestylebgColoransi16m; // Hex (RGB) to 16 million color background code
Related
- ansi-escapes - ANSI escape codes for manipulating the terminal