What is ansi-colors?
The ansi-colors npm package is a utility for styling strings in the terminal with ANSI escape codes. It allows developers to add color and style to text output in command-line applications.
What are ansi-colors's main functionalities?
Text Colors
Apply text color to strings. The example shows how to make text red.
"const colors = require('ansi-colors');\nconsole.log(colors.red('This is red text'));"
Background Colors
Apply background color to strings. The example shows how to give text a red background.
"const colors = require('ansi-colors');\nconsole.log(colors.bgRed('This has a red background'));"
Text Styles
Apply text styles like bold, italic, underline, etc. The example shows how to make text bold.
"const colors = require('ansi-colors');\nconsole.log(colors.bold('This is bold text'));"
Chaining Styles
Chain multiple styles together. The example shows text that is blue, bold, and underlined.
"const colors = require('ansi-colors');\nconsole.log(colors.blue.bold.underline('This is blue, bold, and underlined'));"
Custom Themes
Create custom themes by combining styles. The example defines a custom theme with styles for error and warning messages.
"const colors = require('ansi-colors');\nconst customTheme = {\n error: colors.red.bold,\n warning: colors.yellow.italic\n};\nconsole.log(customTheme.error('Error message'));\nconsole.log(customTheme.warning('Warning message'));"
Other packages similar to ansi-colors
chalk
Chalk is a popular package similar to ansi-colors that provides a chainable API for styling strings. It offers a more extensive API and additional features like template literal support.
kleur
Kleur is a lightweight alternative to ansi-colors, focusing on performance. It has a similar API but does not support older versions of Node.js.
colorette
Colorette is another lightweight package for coloring terminal text. It aims to be fast and simple, with a minimalistic API compared to ansi-colors.
ansi-colors
Collection of ansi colors and styles.
Install
Install with npm:
$ npm install --save ansi-colors
Why was this module created?
This module was created to make it easy to allow color configuration through options. This module inlines the code from these other ansi-* modules for faster load times. The lazy loading of the underlying modules modules has been moved to ansi-colors-lazy.
Usage
var colors = require('ansi-colors');
About
Related projects
- ansi-bgblack: The color bgblack, in ansi. | homepage
- ansi-bgblue: The color bgblue, in ansi. | homepage
- ansi-bgcyan: The color bgcyan, in ansi. | homepage
- ansi-bggreen: The color bggreen, in ansi. | homepage
- ansi-bgmagenta: The color bgmagenta, in ansi. | homepage
- ansi-bgred: The color bgred, in ansi. | homepage
- ansi-bgwhite: The color bgwhite, in ansi. | homepage
- ansi-bgyellow: The color bgyellow, in ansi. | homepage
- ansi-black: The color black, in ansi. | homepage
- ansi-blue: The color blue, in ansi. | homepage
- ansi-bold: The color bold, in ansi. | homepage
- ansi-cyan: The color cyan, in ansi. | homepage
- ansi-dim: The color dim, in ansi. | homepage
- ansi-gray: The color gray, in ansi. | homepage
- ansi-green: The color green, in ansi. | homepage
- ansi-grey: The color grey, in ansi. | homepage
- ansi-hidden: The color hidden, in ansi. | homepage
- ansi-inverse: The color inverse, in ansi. | homepage
- ansi-italic: The color italic, in ansi. | homepage
- ansi-magenta: The color magenta, in ansi. | homepage
- ansi-red: The color red, in ansi. | homepage
- ansi-reset: The color reset, in ansi. | homepage
- ansi-strikethrough: The color strikethrough, in ansi. | homepage
- ansi-underline: The color underline, in ansi. | homepage
- ansi-white: The color white, in ansi. | homepage
- ansi-wrap: Create ansi colors by passing the open and close codes. | homepage
- ansi-yellow: The color yellow, in ansi. | homepage
Contributing
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
Contributors
Building docs
(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)
To generate the readme, run the following command:
$ npm install -g verbose/verb
Running tests
Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:
$ npm install && npm test
Author
Brian Woodward
License
Copyright © 2017, Brian Woodward.
Released under the MIT License.
This file was generated by verb-generate-readme, v0.6.0, on December 06, 2017.