Security News
New Proposed CISA Mandate Would Require Critical Infrastructure to Report Ransom Payments Within 24 Hours
CISA has proposed a set of new rules that would require critical infrastructure to report cyber incidents and ransom payments.
ansi-styles
Advanced tools
ANSI escape codes for styling strings in the terminal
Weekly downloads
Package description
The ansi-styles package provides a collection of ANSI escape codes for styling strings in the terminal. These codes can be used to add color, background color, and various text styles such as bold, italic, underline, etc., to console output.
Color
This feature allows you to apply text color to your strings. The code sample demonstrates how to color the text 'Hello world!' in green.
const ansiStyles = require('ansi-styles');
console.log(`${ansiStyles.green.open}Hello world!${ansiStyles.green.close}`);
Background Color
This feature allows you to apply background color to your strings. The code sample demonstrates how to set the background color of the text 'Hello world!' to blue.
const ansiStyles = require('ansi-styles');
console.log(`${ansiStyles.bgBlue.open}Hello world!${ansiStyles.bgBlue.close}`);
Text Styles
This feature allows you to apply text styles like bold, italic, underline, etc. The code sample demonstrates how to make the text 'Hello world!' bold.
const ansiStyles = require('ansi-styles');
console.log(`${ansiStyles.bold.open}Hello world!${ansiStyles.bold.close}`);
Chalk is a popular npm package that allows you to style terminal strings. It is more user-friendly than ansi-styles as it provides a chainable API and template literal support, making it easier to combine styles.
Colors is another npm package for adding colors to terminal output. It extends String.prototype to add color properties, allowing for a syntax like 'Hello world!'.green. It is less explicit than ansi-styles and can lead to conflicts with other String prototype extensions.
CLI-color is a package for creating colored CLI output. It offers a similar feature set to ansi-styles but also includes additional functionality for cursor movement and window size detection.
Readme
ANSI escape codes for styling strings in the terminal
You probably want the higher-level chalk module for styling your strings.
npm install ansi-styles
import styles from 'ansi-styles';
console.log(`${styles.green.open}Hello world!${styles.green.close}`);
// Color conversion between 256/truecolor
// NOTE: When converting from truecolor to 256 colors, the original color
// may be degraded to fit the new color palette. This means terminals
// that do not support 16 million colors will best-match the
// original color.
console.log(`${styles.color.ansi(styles.rgbToAnsi(199, 20, 250))}Hello World${styles.color.close}`)
console.log(`${styles.color.ansi256(styles.rgbToAnsi256(199, 20, 250))}Hello World${styles.color.close}`)
console.log(`${styles.color.ansi16m(...styles.hexToRgb('#abcdef'))}Hello World${styles.color.close}`)
Each style has an open
and close
property.
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)black
red
green
yellow
blue
magenta
cyan
white
blackBright
(alias: gray
, grey
)redBright
greenBright
yellowBright
blueBright
magentaBright
cyanBright
whiteBright
bgBlack
bgRed
bgGreen
bgYellow
bgBlue
bgMagenta
bgCyan
bgWhite
bgBlackBright
(alias: bgGray
, bgGrey
)bgRedBright
bgGreenBright
bgYellowBright
bgBlueBright
bgMagentaBright
bgCyanBright
bgWhiteBright
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
import styles from 'ansi-styles';
console.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.
import styles from 'ansi-styles';
console.log(styles.codes.get(36));
//=> 39
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:
import styles from 'ansi-styles';
styles.color.ansi(styles.rgbToAnsi(100, 200, 15)); // RGB to 16 color ansi foreground code
styles.bgColor.ansi(styles.hexToAnsi('#C0FFEE')); // HEX to 16 color ansi foreground code
styles.color.ansi256(styles.rgbToAnsi256(100, 200, 15)); // RGB to 256 color ansi foreground code
styles.bgColor.ansi256(styles.hexToAnsi256('#C0FFEE')); // HEX to 256 color ansi foreground code
styles.color.ansi16m(100, 200, 15); // RGB to 16 million color foreground code
styles.bgColor.ansi16m(...styles.hexToRgb('#C0FFEE')); // Hex (RGB) to 16 million color foreground code
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.
FAQs
ANSI escape codes for styling strings in the terminal
The npm package ansi-styles receives a total of 266,942,350 weekly downloads. As such, ansi-styles popularity was classified as popular.
We found that ansi-styles demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
CISA has proposed a set of new rules that would require critical infrastructure to report cyber incidents and ransom payments.
Security News
Redis is no longer OSS, breaking its explicit commitment to remain under the BSD 3-Clause License forever. This has angered contributors who are now working to fork the software.
Product
Socket AI now enables 'AI detected potential malware' alerts by default, ensuring users benefit from AI-powered state-of-the-art malware detection without needing to opt-in.