Big update!Announcing Socket for GitHub 1.0. Learn more
Socket
BlogLoveFAQ
Install
Log in

ansi-styles

Package Overview
Dependencies
0
Maintainers
2
Versions
24
Issues
File Explorer

Advanced tools

ansi-styles

ANSI escape codes for styling strings in the terminal

    6.1.0latest

Version published
Maintainers
2
Weekly downloads
190,237,785
increased by0.13%

Weekly downloads

Changelog

Source

  • Add support for ansi colors and add .ansi256ToAnsi(), .rgbToAnsi() and .hexToAnsi() (#71) 2ceace1

https://github.com/chalk/ansi-styles/compare/v6.0.0...v6.1.0

Readme

Source

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

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}`)

API

Each style has an open and close property.

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
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.

Example
import styles from 'ansi-styles'; console.log(styles.codes.get(36)); //=> 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:

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
  • ansi-escapes - ANSI escape codes for manipulating the terminal

Maintainers

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.

Keywords

FAQs

What is ansi-styles?

ANSI escape codes for styling strings in the terminal

Is ansi-styles popular?

The npm package ansi-styles receives a total of 181,428,649 weekly downloads. As such, ansi-styles popularity was classified as popular.

Is ansi-styles well maintained?

We found that ansi-styles demonstrated a not healthy version release cadence and project activity. It has 2 open source maintainers collaborating on the project.

Last updated on 21 Apr 2021
Socket

Product

Subscribe to our newsletter

Get open source security insights delivered straight into your inbox. Be the first to learn about new features and product updates.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc