ansi-styles
Advanced tools
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
const style = require('ansi-styles');
console.log(`${style.green.open}Hello world!${style.green.close}`);
// 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.log(`${style.color.ansi256(style.rgbToAnsi256(199, 20, 250))}Hello World${style.color.close}`)
console.log(`${style.color.ansi16m(...style.hexToRgb('#abcdef'))}Hello World${style.color.close}`)
Each style has an open and close property.
resetbolddimitalic (Not widely supported)underlineinversehiddenstrikethrough (Not widely supported)blackredgreenyellowbluemagentacyanwhiteblackBright (alias: gray, grey)redBrightgreenBrightyellowBrightblueBrightmagentaBrightcyanBrightwhiteBrightbgBlackbgRedbgGreenbgYellowbgBluebgMagentabgCyanbgWhitebgBlackBright (alias: bgGray, bgGrey)bgRedBrightbgGreenBrightbgYellowBrightbgBlueBrightbgMagentaBrightbgCyanBrightbgWhiteBrightBy 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.modifierstyle.colorstyle.bgColorconsole.log(style.color.green.open);
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.
console.log(style.codes.get(36));
//=> 39
ansi-styles allows converting between various color formats and ANSI escapes, with support for 256 and 16 million colors.
The following color spaces from color-convert are supported:
rgbhexansi256To use these, call the associated conversion function with the intended output, for example:
style.color.ansi256(style.rgbToAnsi256(100, 200, 15)); // RGB to 256 color ansi foreground code
style.bgColor.ansi256(style.hexToAnsi256('#C0FFEE')); // HEX to 256 color ansi foreground code
style.color.ansi16m(100, 200, 15); // RGB to 16 million color foreground code
style.bgColor.ansi16m(...style.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 332,496,873 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
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.
Security News
UnitedHealth Group disclosed that the ransomware attack on Change Healthcare compromised protected health information for millions in the U.S., with estimated costs to the company expected to reach $1 billion.