1 # ansi-styles [![Build Status](https://travis-ci.org/chalk/ansi-styles.svg?branch=master)](https://travis-ci.org/chalk/ansi-styles)
3 > [ANSI escape codes](https://en.wikipedia.org/wiki/ANSI_escape_code#Colors_and_Styles) for styling strings in the terminal
5 You probably want the higher-level [chalk](https://github.com/chalk/chalk) module for styling your strings.
7 <img src="screenshot.svg" width="900">
12 $ npm install ansi-styles
18 const style = require('ansi-styles');
20 console.log(`${style.green.open}Hello world!${style.green.close}`);
23 // Color conversion between 16/256/truecolor
24 // NOTE: If conversion goes to 16 colors or 256 colors, the original color
25 // may be degraded to fit that color palette. This means terminals
26 // that do not support 16 million colors will best-match the
28 console.log(style.bgColor.ansi.hsl(120, 80, 72) + 'Hello world!' + style.bgColor.close);
29 console.log(style.color.ansi256.rgb(199, 20, 250) + 'Hello world!' + style.color.close);
30 console.log(style.color.ansi16m.hex('#abcdef') + 'Hello world!' + style.color.close);
35 Each style has an `open` and `close` property.
44 - `italic` *(Not widely supported)*
48 - `strikethrough` *(Not widely supported)*
60 - `blackBright` (alias: `gray`, `grey`)
79 - `bgBlackBright` (alias: `bgGray`, `bgGrey`)
90 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.
99 console.log(style.color.green.open);
102 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.
107 console.log(style.codes.get(36));
111 ## [256 / 16 million (TrueColor) support](https://gist.github.com/XVilka/8346728)
113 `ansi-styles` uses the [`color-convert`](https://github.com/Qix-/color-convert) package to allow for converting between various colors and ANSI escapes, with support for 256 and 16 million colors.
115 The following color spaces from `color-convert` are supported:
126 To use these, call the associated conversion function with the intended output, for example:
129 style.color.ansi.rgb(100, 200, 15); // RGB to 16 color ansi foreground code
130 style.bgColor.ansi.rgb(100, 200, 15); // RGB to 16 color ansi background code
132 style.color.ansi256.hsl(120, 100, 60); // HSL to 256 color ansi foreground code
133 style.bgColor.ansi256.hsl(120, 100, 60); // HSL to 256 color ansi foreground code
135 style.color.ansi16m.hex('#C0FFEE'); // Hex (RGB) to 16 million color foreground code
136 style.bgColor.ansi16m.hex('#C0FFEE'); // Hex (RGB) to 16 million color background code
141 - [ansi-escapes](https://github.com/sindresorhus/ansi-escapes) - ANSI escape codes for manipulating the terminal
145 - [Sindre Sorhus](https://github.com/sindresorhus)
146 - [Josh Junon](https://github.com/qix-)
150 Available as part of the Tidelift Subscription.
152 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.](https://tidelift.com/subscription/pkg/npm-ansi-styles?utm_source=npm-ansi-styles&utm_medium=referral&utm_campaign=enterprise&utm_term=repo)