| | |
| | | # ansi-styles [](https://travis-ci.org/chalk/ansi-styles) |
| | | |
| | | > [ANSI escape codes](http://en.wikipedia.org/wiki/ANSI_escape_code#Colors_and_Styles) for styling strings in the terminal |
| | | > [ANSI escape codes](https://en.wikipedia.org/wiki/ANSI_escape_code#Colors_and_Styles) for styling strings in the terminal |
| | | |
| | | You probably want the higher-level [chalk](https://github.com/chalk/chalk) module for styling your strings. |
| | | |
| | | <img src="https://cdn.rawgit.com/chalk/ansi-styles/8261697c95bf34b6c7767e2cbe9941a851d59385/screenshot.svg" width="900"> |
| | | |
| | | <img src="screenshot.svg" width="900"> |
| | | |
| | | ## Install |
| | | |
| | | ``` |
| | | $ npm install ansi-styles |
| | | ``` |
| | | |
| | | |
| | | ## Usage |
| | | |
| | |
| | | // original color. |
| | | console.log(style.bgColor.ansi.hsl(120, 80, 72) + 'Hello world!' + style.bgColor.close); |
| | | console.log(style.color.ansi256.rgb(199, 20, 250) + 'Hello world!' + style.color.close); |
| | | console.log(style.color.ansi16m.hex('#ABCDEF') + 'Hello world!' + style.color.close); |
| | | console.log(style.color.ansi16m.hex('#abcdef') + 'Hello world!' + style.color.close); |
| | | ``` |
| | | |
| | | ## API |
| | | |
| | | Each style has an `open` and `close` property. |
| | | |
| | | |
| | | ## Styles |
| | | |
| | |
| | | - `magenta` |
| | | - `cyan` |
| | | - `white` |
| | | - `gray` ("bright black") |
| | | - `blackBright` (alias: `gray`, `grey`) |
| | | - `redBright` |
| | | - `greenBright` |
| | | - `yellowBright` |
| | |
| | | - `bgMagenta` |
| | | - `bgCyan` |
| | | - `bgWhite` |
| | | - `bgBlackBright` |
| | | - `bgBlackBright` (alias: `bgGray`, `bgGrey`) |
| | | - `bgRedBright` |
| | | - `bgGreenBright` |
| | | - `bgYellowBright` |
| | |
| | | - `bgMagentaBright` |
| | | - `bgCyanBright` |
| | | - `bgWhiteBright` |
| | | |
| | | |
| | | ## Advanced usage |
| | | |
| | |
| | | //=> 39 |
| | | ``` |
| | | |
| | | |
| | | ## [256 / 16 million (TrueColor) support](https://gist.github.com/XVilka/8346728) |
| | | |
| | | `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. |
| | | |
| | | The following color spaces from `color-convert` are supported: |
| | | |
| | | - `rgb` |
| | | - `hex` |
| | | - `keyword` |
| | | - `hsl` |
| | | - `hsv` |
| | | - `hwb` |
| | | - `ansi` |
| | | - `ansi256` |
| | | |
| | | To use these, call the associated conversion function with the intended output, for example: |
| | | |
| | |
| | | style.bgColor.ansi16m.hex('#C0FFEE'); // Hex (RGB) to 16 million color background code |
| | | ``` |
| | | |
| | | |
| | | ## Related |
| | | |
| | | - [ansi-escapes](https://github.com/sindresorhus/ansi-escapes) - ANSI escape codes for manipulating the terminal |
| | | |
| | | |
| | | ## Maintainers |
| | | |
| | | - [Sindre Sorhus](https://github.com/sindresorhus) |
| | | - [Josh Junon](https://github.com/qix-) |
| | | |
| | | ## For enterprise |
| | | |
| | | ## License |
| | | Available as part of the Tidelift Subscription. |
| | | |
| | | MIT |
| | | 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) |