https://github.com/kauefraga/cpp-colors
🎨 A collection of namespaces (ANSI escape code for colors) and functions that will help you to style and bring life to your console outputs.
https://github.com/kauefraga/cpp-colors
ansi-colors ascii colors console cplusplus cpp lib library style terminal
Last synced: 2 months ago
JSON representation
🎨 A collection of namespaces (ANSI escape code for colors) and functions that will help you to style and bring life to your console outputs.
- Host: GitHub
- URL: https://github.com/kauefraga/cpp-colors
- Owner: kauefraga
- License: mit
- Created: 2023-06-27T19:35:29.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-07-03T22:32:52.000Z (about 3 years ago)
- Last Synced: 2025-04-02T23:45:23.534Z (over 1 year ago)
- Topics: ansi-colors, ascii, colors, console, cplusplus, cpp, lib, library, style, terminal
- Language: C++
- Homepage:
- Size: 58.6 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# C++ Colors Library
> 🎨 A collection of namespaces (ANSI escape code for colors) and functions that will help you to style and bring life to your console outputs.
### Features
- Ready for use! Drop it in your codebase and be happy!!!
- Just copy the file `colors.hpp` in your project and prettify your outputs.
- Simple and well-written interfaces so you don't have to worry about readability.
- Support for 4 bit colors (standard and high-intensity colors).
- `Fore` namespace that has ANSI code for the main (more supported) foreground colors.
- `Back` namespace that has ANSI code for background colors.
- `Style` namespace that has ANSI code for apply style like bold, italic, underline, and so on.
- Written following [Google's c++ style guide](https://google.github.io/styleguide/cppguide.html).
## ⬇️ Getting Started
1. Download or clone the repository
2. Copy the file at `src` into your codebase
3. See [usage](#🤹♀️-usage) and [api](#📖-api)
```bash
# (1)
git clone https://github.com/kauefraga/cpp-colors.git
cd cpp-colors
# (2)
cp src/colors.cpp ../path/to/your/project
```
You are welcome to open issues and pull requests!
## 🤹♀️ Usage
To have access to the cpp-colors features you need to include the file `src/colors.hpp` in your codebase.
Example: include the library in your code and then use the namespaces to output "something" in bold red.
```cpp
// Already includes and
#include "../path/to/cpp-colors/colors.hpp"
int main() {
std::cout << style::bold << fore::red << "something" << '\n';
// style::bold + fore::red works too, because << operator also concatenates
return 0;
}
```
## 📖 API
### Functions
- `print(string text, string color, char eol)` - Prints out a text with a style (color, bold...)
### Modifiers (`style` namespace)
- `style::reset` - Reset the current style.
- `style::bold` - Make the text bold. Alias: `style::b`
- `style::dim` - Make the text have lower opacity.
- `style::italic` - Make the text italic. Alias: `style::i` *(not widely supported)*
- `style::underline` - Put a horizontal line below the text. Alias: `style::u` *(not widely supported)*
- `style::normal` - Make the text normal.
- `style::strikethrough` - Puts a horizontal line through the center of the text. Alias: `style::st` *(Not widely supported)*
### Colors (`fore` and `back` namespaces)
The available foreground colors are below:
- `fore::black`
- `fore::red`
- `fore::green`
- `fore::yellow`
- `fore::blue`
- `fore::magenta`
- `fore::cyan`
- `fore::white`
- `fore::bright_black` - Alias: `fore::gray`
- `fore::bright_red`
- `fore::bright_green`
- `fore::bright_yellow`
- `fore::bright_blue`
- `fore::bright_magenta`
- `fore::bright_cyan`
- `fore::bright_white`
Also, see the usable background colors:
- `back::black`
- `back::red`
- `back::green`
- `back::yellow`
- `back::blue`
- `back::magenta`
- `back::cyan`
- `back::white`
- `back::bright_black` - Alias: `back::gray`
- `back::bright_red`
- `back::bright_green`
- `back::bright_yellow`
- `back::bright_blue`
- `back::bright_magenta`
- `back::bright_cyan`
- `back::bright_white`
Read the doxygen documentation at [code](src/colors.hpp) too.
## 🧻 Resources
These are the contents that i consume to develop this library:
- [ANSI escape code](https://en.wikipedia.org/wiki/ANSI_escape_code)
- [Python - Colorama's codebase](https://github.com/tartley/colorama/blob/master/colorama/ansi.py)
- [List of ANSI color escape sequences](https://stackoverflow.com/questions/4842424/list-of-ansi-color-escape-sequences)
## 📝 License
This project is licensed under the MIT License - See the [LICENSE](https://github.com/kauefraga/cpp-colors/blob/main/LICENSE) for more information.