You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

147 lines
3.6 KiB

4 years ago
  1. # ansi-styles [![Build Status](https://travis-ci.org/chalk/ansi-styles.svg?branch=master)](https://travis-ci.org/chalk/ansi-styles)
  2. > [ANSI escape codes](http://en.wikipedia.org/wiki/ANSI_escape_code#Colors_and_Styles) for styling strings in the terminal
  3. You probably want the higher-level [chalk](https://github.com/chalk/chalk) module for styling your strings.
  4. <img src="https://cdn.rawgit.com/chalk/ansi-styles/8261697c95bf34b6c7767e2cbe9941a851d59385/screenshot.svg" width="900">
  5. ## Install
  6. ```
  7. $ npm install ansi-styles
  8. ```
  9. ## Usage
  10. ```js
  11. const style = require('ansi-styles');
  12. console.log(`${style.green.open}Hello world!${style.green.close}`);
  13. // Color conversion between 16/256/truecolor
  14. // NOTE: If conversion goes to 16 colors or 256 colors, the original color
  15. // may be degraded to fit that color palette. This means terminals
  16. // that do not support 16 million colors will best-match the
  17. // original color.
  18. console.log(style.bgColor.ansi.hsl(120, 80, 72) + 'Hello world!' + style.bgColor.close);
  19. console.log(style.color.ansi256.rgb(199, 20, 250) + 'Hello world!' + style.color.close);
  20. console.log(style.color.ansi16m.hex('#ABCDEF') + 'Hello world!' + style.color.close);
  21. ```
  22. ## API
  23. Each style has an `open` and `close` property.
  24. ## Styles
  25. ### Modifiers
  26. - `reset`
  27. - `bold`
  28. - `dim`
  29. - `italic` *(Not widely supported)*
  30. - `underline`
  31. - `inverse`
  32. - `hidden`
  33. - `strikethrough` *(Not widely supported)*
  34. ### Colors
  35. - `black`
  36. - `red`
  37. - `green`
  38. - `yellow`
  39. - `blue`
  40. - `magenta`
  41. - `cyan`
  42. - `white`
  43. - `gray` ("bright black")
  44. - `redBright`
  45. - `greenBright`
  46. - `yellowBright`
  47. - `blueBright`
  48. - `magentaBright`
  49. - `cyanBright`
  50. - `whiteBright`
  51. ### Background colors
  52. - `bgBlack`
  53. - `bgRed`
  54. - `bgGreen`
  55. - `bgYellow`
  56. - `bgBlue`
  57. - `bgMagenta`
  58. - `bgCyan`
  59. - `bgWhite`
  60. - `bgBlackBright`
  61. - `bgRedBright`
  62. - `bgGreenBright`
  63. - `bgYellowBright`
  64. - `bgBlueBright`
  65. - `bgMagentaBright`
  66. - `bgCyanBright`
  67. - `bgWhiteBright`
  68. ## Advanced usage
  69. 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.
  70. - `style.modifier`
  71. - `style.color`
  72. - `style.bgColor`
  73. ###### Example
  74. ```js
  75. console.log(style.color.green.open);
  76. ```
  77. 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.
  78. ###### Example
  79. ```js
  80. console.log(style.codes.get(36));
  81. //=> 39
  82. ```
  83. ## [256 / 16 million (TrueColor) support](https://gist.github.com/XVilka/8346728)
  84. `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.
  85. To use these, call the associated conversion function with the intended output, for example:
  86. ```js
  87. style.color.ansi.rgb(100, 200, 15); // RGB to 16 color ansi foreground code
  88. style.bgColor.ansi.rgb(100, 200, 15); // RGB to 16 color ansi background code
  89. style.color.ansi256.hsl(120, 100, 60); // HSL to 256 color ansi foreground code
  90. style.bgColor.ansi256.hsl(120, 100, 60); // HSL to 256 color ansi foreground code
  91. style.color.ansi16m.hex('#C0FFEE'); // Hex (RGB) to 16 million color foreground code
  92. style.bgColor.ansi16m.hex('#C0FFEE'); // Hex (RGB) to 16 million color background code
  93. ```
  94. ## Related
  95. - [ansi-escapes](https://github.com/sindresorhus/ansi-escapes) - ANSI escape codes for manipulating the terminal
  96. ## Maintainers
  97. - [Sindre Sorhus](https://github.com/sindresorhus)
  98. - [Josh Junon](https://github.com/qix-)
  99. ## License
  100. MIT